TUPConnectReq

Requests the establishment of a circuit switched connection.

Prototype

DWORD NMSAPI TUPConnectReq ( CTAHD ctahd, U8 board, TupSpId spId, TupInstId suInstId, TupInstId spInstId, Bool cirSelFlg, CirIdx circuit, TupConEvnt *conEvnt)

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.

cirSelFlg

Circuit selection flag.

circuit

Circuit index used for this connection if cirSelFlg is set to true.

conEvnt

Pointer to the caller's connect event structure containing all parameters (IEs) relevant to establishing this connection.


Return values

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.


Details

When successful, TUPConnectReq results in an initial address message (IAM, IAI) being sent to the far exchange. The TUP service generates an IAI message if any one of the cgPtyNum, origCdNum, and clUsrGrp IEs are filled. Otherwise, an IAM is generated.

If the TUP layer cannot successfully initiate the outgoing connection request (for example, due to network congestion or the requested circuit not being idle), it returns an asynchronous STATUS INDICATION event to the application with the cause value coded with the reason for the failure.

For more information, refer to Establishing connections and Handling failed connection requests.