(Page 9 of 23 in this chapter) Version

nccGetLineStatus

Description

Retrieves a snapshot of the port status and stores it in an NCC_LINE_STATUS structure.

Prototype

DWORD nccGetLineStatus ( CTAHD linehd,
NCC_LINE_STATUS *linestatus,
unsigned linestatussize,
NCC_CALLHD callhd[],
unsigned callhdsize )

linehd CT Access context handle on which NCC line is opened via ctaOpenServices.

linestatus Pointer to buffer to receive the information. The NCC_LINE_STATUS structure is shown here:

typedef struct
{
  DWORD size;          /* No of bytes written to by linestatus    */ 
  DWORD state;         /* Current state of line                    */ 
  DWORD pendingcmd;   /* Last command not ack'd by board         */ 
  char protocol[NCC_MAX_PNAME+1]; /* Array of protocols on line */ 
  CTA_MVIP_ADDR port; /* MVIP address of port                   */ 
  unsigned numcallhd; /* Number of unreleased call handles      */ 
} NCC_LINE_STATUS;
linestatussize Amount of memory available at status, which must be large enough to receive the NCC_LINE_STATUS size return value.

callhd Array of call handles to be set to the values of calls that are on this line that have not been released. This can be NULL if the user does not wish to get a list of all the call handles on the line.

callhdsize Size in bytes of the callhd array. This is ignored if callhd is NULL.

Return Values

Events

None.

Details

This function retrieves the line status of the specified line or ctahd. Upon returning from the function, the NCC_LINE_STATUS size field contains the actual number of bytes written.

The NCC_LINE_STATUS structure contains the following fields:
Field

Description

size

 Number of bytes written at the address pointed to by linestatus.

state

 Current line state. Can be any of the following:

NCC_LINESTATE_UNINITIALIZED

NCC_LINESTATE_IDLE

NCC_LINESTATE_BLOCKING

NCC_LINESTATE_OUT_OF_SERVICE

NCC_LINESTATE_ACTIVE

pendingcmd

 The last line command issued that has not yet been acknowledged by the AG board. This field is set when a line control command is sent to the board, and cleared on the next event that corresponds to the acknowledgment of the pending command.

Possible values are:

(0) No command pending.

NCC_PENDINGCMD_BLOCK_CALLS

NCC_PENDINGCMD_UNBLOCK_CALLS

NCC_PENDINGCMD_START_PROTOCOL

NCC_PENDINGCMD_STOP_PROTOCOL

protocol

 Arrays containing names of protocols running on this line.

port

 MVIP address of call control resource (port), if needed, specified with ctaOpenServices invocation of.

numcallhd

 Number of unreleased call handles, starting from index 0.

See Also

nccGetCallStatus, nccGetExtendedCallStatus


(Page 9 of 23 in this chapter) Version

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