SccpGetUSapStatus

Retrieves the user service access point status for a specified user service access point ID.

Prototype

SCCP_STATUS SccpGetUSapStatus ( U8 board, SccpUSapStatus *pStatus, U16 sapId)

Argument

Description

board

TX board number to which this request is directed.

pStatus

Pointer to the address of the caller's SCCP user service access point status buffer where the status is returned:

typedef struct
{
  U8         month;   /* month                   */
  U8         day;     /* day                     */
  U8         year;    /* year - since 1900       */
  U8         hour;    /* hour - 24 hour clock    */
  U8         min;     /* minute                  */
  U8         sec;     /* second                  */
  U8         tenths;  /* tenths of second        */
  U8         fill;    /* alignment               */
} DateTime;

typedef struct
{
  U32        opc;       /* OPC                            */
  U16        opcStatus; /* status for this OPC            */
} OpcStatusInfo;

typedef struct 
{
  DateTime   dt;          /* Date and Time                  */
  S16        sapStatus;   /* status                         */
  U16       numAltOpc;   /* number of Alternate PCs        */
  OpcStatusInfo opcInfo[SCCP_MAXALTOPC];
  U8         inCongLevel; /* inbound queue congestion level */
  U16        spare1;      /* spare for alignment            */
} SccpUSapStatus;

Refer to the Details section for valid status values.

sapId

User service access point ID being retrieved.


Return values

Return value

Description

SCCP_SUCCESS

 

SCCP_BOARD

board is out of range.

SCCP_DRIVER

Error occurred accessing the driver.

SCCP_EXCEEDMAXCFG

User service access point ID is out of the configured range.

SCCP_NOGENCFG

SccpSetGenCfg has not been called.

SCCP_NULLPTR

Null pointer was specified for pStatus.

SCCP_RESOURCES

TX board resource is exhausted. Check the txalarm log.

SCCP_TIMEOUT

Request timed out.

SCCP_UNINIT

Application failed to call SccpMgmtInit prior to this call.


Details

The following status values are bit-set:

0x01

SCCP_STA_BND

Bind

0x02

SCCP_STA_FLCOFF

Flow control off

0x04

SCCP_STA_GUARD

Guarding

0x08

SCCP_STA_BRT

Backup routed

0x10

SCCP_STA_GRNT

Waiting for grant

0x20

SCCP_STA_IGNR

Ignore

0x40

SCCP_STA_PROH

Prohibited

0x80

SCCP_STA_REST

Restarting