(Page 20 of 23 in this chapter) Version


nccStartProtocol

Description

Prepares an uninitialized line to be used by a protocol to accept and/or place calls.

Prototype

DWORD nccStartProtocol ( CTAHD linehd,
char *protname,
NCC_START_PARMS *startparms)
void *mgrstartparms,
void *protstartparms )

linehd Line (context) handle to initialize.

protname Name of protocol to start on the line.

startparms Pointer to NCC_START_PARMS containing generic NCC protocol-starting parameters. The default parameters can be used by setting this argument to NULL.

typedef struct
{
 DWORD size;
 DWORD eventmask;
 WORD  debugflag;
 WORD  waitforPCtime;
 WORD  overlappedreceiving;
 struct
 {
  DWORD size;
  WORD  dialtonefreq1;
  WORD  dialtonefreq2;
  WORD  dialtoneontime1;
  WORD  dialtoneontime2;
  WORD  dialtoneofftime1;
  WORD  dialtoneofftime2;
  WORD  dialtonelevel;
  WORD  ringfreq1;
  WORD  ringfreq2;
  WORD  ringontime;
  WORD  ringofftime1;
  WORD  ringofftime2;
  WORD  ringtonelevel;
  WORD  busyfreq1;
  WORD  busyfreq2;
  WORD  busyontime;
  WORD  busyofftime;
  WORD  busytonelevel;
  WORD  fastbusyfreq1;
  WORD  fastbusyfreq2;
  WORD  fastbusyontime;
  WORD  fastbusyofftime;
  WORD  fastbusytonelevel;
 } callproggenerate;
} NCC_START_PARMS;

mgrstartparms Pointer to manager-specific CT Access protocol-starting parameter structure. For protocol-independent applications, the default parameters can be used by setting this argument to NULL.

protostartparms Pointer to protocol-specific CT Access protocol-starting parameter structure. For protocol-independent applications, the default parameters can be used by setting this argument to NULL.

Return Values

Events

Details

When this function is invoked, it returns NCCEVN_START_PROTOCOL_DONE. This event acknowledges the protocol startup attempt. The event value field indicates whether the attempt was successful or not. The following reason codes may be returned:

NCC_START_PARMS contains the following parameters:
Parameter

Description

Parameters that control general NCC service functions:

eventmask

Controls reporting of various call control events. For details, see Appendix D.

debugflag

Off (0) or on (non-zero). Used to report low-level debug events to the application.

waitforPCtime

Time the protocol gives an application to respond to an NCCEVN_INCOMING_CALL event.

overlappedreceiving

Determines if the protocol will receive digits in overlapped receiving mode.

Call progress generation parameters. These parameters describe the call progress tones in the target country:

callproggen.dialtonefreq1

First frequency of dialtone

callproggen.dialtonefreq2

Second frequency of dialtone

callproggen.dialtoneontime1

Cadenced dialtone: first ON time

callproggen.dialtoneontime2

Cadenced dialtone: second ON time

callproggen.dialtoneofftime1

Cadenced dialtone: first OFF time

callproggen.dialtoneofftime2

Cadenced dialtone: second OFF time

callproggen.dialtonelevel

Dialtone amplitude

callproggen.ringfreq1

First frequency of ringback tone

callproggen.ringfreq2

Second frequency of ringback tone

callproggen.ringontime

Ringback tone ON time

callproggen.ringofftime1

Ringback tone first (or only) OFF time

callproggen.ringofftime2

Ringback tone second OFF time

callproggen.ringtonelevel

Ringback tone amplitude

callproggen.busyfreq1

First frequency of busy tone

callproggen.busyfreq2

Second frequency of busy tone

callproggen.busyontime

Busy tone ON time

callproggen.busyofftime

Busy tone OFF time

callproggen.busytonelevel

Busy tone amplitude

callproggen.fastbusyfreq1

First frequency of fast busy (reorder) tone

callproggen.fastbusyfreq2

Second frequency of fast busy (reorder) tone

callproggen.fastbusyontime

Fast busy tone ON time

callproggen.fastbusyofftime

Fast busy tone OFF time

callproggen.fastbusytonelevel

Fast busy tone amplitude

Refer to Appendix D for an example of default NCC_START_PARMS parameter settings.

See Also

ctaOpenServices, nccStopProtocol



(Page 20 of 23 in this chapter) Version


tech_support@nmss.com
Copyright © 1999, Natural MicroSystems, Inc. All rights reserved.