Sends an SCCP service access point (SAP) configuration parameter block to the specified TX board to define or update the configuration for a specific SCCP SAP.
SCCP_STATUS SccpSetUSapCfg ( U8 board, SccpUSapCfg *pCfg, U16 sapId)
Argument |
Description |
board |
TX board number. |
pCfg |
Pointer to the address of the service access point configuration parameters buffer. The format is specified in SccpInitUSapCfg. |
sapId |
Service access point ID being defined. |
Return value |
Description |
SCCP_SUCCESS |
|
SCCP_BADDIGIT |
addrMsk contains invalid digits. |
SCCP_BOARD |
board is out of range. |
SCCP_BUFLEN |
Either addrMsk.length or numConPc is out of range. |
SCCP_DRIVER |
Error occurred accessing the driver. |
SCCP_EXCEEDMAXCFG |
sapId exceeds the maximum specified through SccpSetGenCfg. |
SCCP_HOPCOUNT |
hopCnt is out of range. |
SCCP_NOGENCFG |
SccpSetGenCfg has not been called. |
SCCP_NULLPTR |
Null pointer was specified for pCfg. |
SCCP_PARAM |
Invalid parameter was detected. Check the txalarm log. |
SCCP_POINTCODE |
Backup or concerned point code exceeds 24 bits. |
SCCP_RESOURCES |
TX board resource is exhausted. Check the txalarm log. |
SCCP_SWTYPE |
swType contains an invalid switch type. |
SCCP_TIMEOUT |
Request timed out. |
SCCP_UNINIT |
Application failed to call SccpMgmtInit prior to this call. |
SCCP_ZEROLEN |
addrMsk.length is zero while useMsk is set to 1. |
This function can be called any time after the general configuration is downloaded to the TX board, but before any application attempts to bind to this SAP for transaction processing.
pCfg must have been previously initialized with SccpInitUSapCfg.
The first time SccpSetUSapCfg is called after a download of the TX board, all the parameters listed in SccpInitUSapCfg can be modified. On any subsequent call to SccpSetUSapCfg (without downloading the board), only some parameters can be modified. These are listed in bold in SccpInitUSapCfg. Those fields not in bold are ignored on subsequent calls.