Sends a global or circuit-specific message to the far exchange.
DWORD NMSAPI TUPStatusReq ( CTAHD ctahd, U8 board, TupSpId spId, TupInstId suInstId, TupInstId spInstId, CirIdx circuit, U8 evntType, TupStaEvnt *staEvnt)
|
Argument |
Description |
|
ctahd |
Natural Access handle. |
|
board |
TX board number. |
|
spId |
TUP service access point. |
|
suInstId |
Service user instance ID. |
|
spInstId |
Service provider instance ID. |
|
circuit |
For circuit-specific requests, the circuit index with which this request is associated. For circuit group specific requests, this argument must identify one member of the circuit group. |
|
evntType |
Type of status request. Refer to the Details section for a list of valid status request types. |
|
staEvnt |
Pointer to the caller's status event structure containing all parameters (IEs) included in the message to the far exchange. |
|
Return value |
Description |
|
TUP_SUCCESS |
|
|
TUP_INVBOARD |
board is out of range. |
|
TUP_NOTBOUND |
Application failed to open the TUP service. |
|
TUP_OSERROR |
Error occurred accessing the driver. |
|
TUP_UNKEVENT |
Unrecognized event type requested. |
The following table lists the valid status request types (evntType):
|
Status request type |
Description |
|
TUPCONTCHK |
Continuity check (CCR) |
|
TUPCONTREP |
Continuity report (COT) |
|
TUPCONFAIL |
Continuity report (CCF) |
|
TUPCIRBLKREQ |
Circuit block request (BLO) |
|
TUPCIRUNBLKREQ |
Circuit unblock request (UBL) |
|
TUPCIRRESREQ |
Circuit reset request (RSC) |
|
TUPCRMGRPBLKREQ |
Maintenance circuit group block request (MGB)* |
|
TUPCRMGRPUNBLKREQ |
Maintenance circuit group unblock request (MGU)* |
|
TUPCRHGRPBLKREQ |
Hardware circuit group block request (HGB)* |
|
TUPCRHGRPUNBLKREQ |
Hardware circuit group unblock request (HGU)* |
|
TUPCRSGRPBLKREQ |
Software circuit group block request (SGB)* |
|
TUPCRSGRPUNBLKREQ |
Software circuit group unblock request (SGU)* |
|
TUPCIRGRPRESREQ |
Circuit group reset request (GRS) |
|
TUPSWITCHCONG |
Switch equipment congestion (SEC) |
|
TUPCIRCUITCONG |
Circuit group congestion (CGC) |
|
TUPNATIONALCONG |
Nation network congestion (NNC) |
|
TUPADDRESSINCOMP |
Address incomplete (ADI) |
|
TUPCALLFAILURE |
Call failure (CFL) |
|
TUPSUBBUSY |
Subscriber busy (SSB) |
|
TUPUNALLOCATEDNUM |
Unallocated number (UNN) |
|
TUPOUTOFSERVICE |
Line out of service (LOS) |
|
TUPSENDSPECIAL |
Send special tone (SST) |
|
TUPACCESSBARRED |
Access barred (ACB) |
|
TUPNODIGITAL |
Digital path not provided (DPN) |
|
TUPEXTENDEDINFO |
Extended unsuccessful message (EUM) |
|
TUPCLEARBKW |
Clear backwards (CBK) |
|
TUPMISDIALEDPREFIX |
Misdialed trunk prefix (MPR) - not supported in China |
|
TUPSUBLOCALBUSY |
Subscriber local busy (SLB) - China only |
|
TUPSUBTOLLBUSY |
Subscriber toll busy (STB) - China only |
When sending one of the status request events marked with an asterisk (*), populate the range information element in staEvnt. If all circuits in the predefined group should be acted upon, set the range field to zero (0) and ignore the statusMap. If some of the circuits should not be acted upon or this is not a predefined group, set range to the number of circuits that can be acted upon. Then set the statusMap array as follows: set an element indexed into this array to one (1) if this circuit should be acted upon, or set it to zero (0) if it should not be acted upon. The first element in the array maps to the circuit parameter sent to TUPStatusReq. The remainder of the array maps to the consecutive circuits in the defined group. Refer to the TUP specifications for more information.