TCAPGenStatus

Retrieves the TCAP general status structure.

Prototype

S16 TCAPGenStatus ( U8 board, TcapGenStatus *status)

Argument

Description

board

TX board number.

status

Pointer to the TcapGenStatus structure:

/* TCAP General statistics structure */
typedef struct TCAP_Gen_Stats
{
   U8    haSt;       /* high availability state */
   U8    mcSt;       /* mate connection state   */
} TcapGenStatus;

Refer to the Details section for more information.


Return values

Return value

Description

TCAP_SUCCESS

 

TCAPM_BOARD

board is out of range.

TCAPM_DRIVER

Error occurred accessing the driver.

TCAP_FAILED

Task on the TX board reported a failure.

TCAPM_NULLPTR

Null pointer was specified for status.

TCAPM_TIMEOUT

Request timed out.

TCAPM_UNINIT

Application failed to call TCAPInitMgmtAPI prior to this call.


Details

haSt has the following valid values:

Value

Description

0

ST_HAST_STARTING

1

ST_HAST_STANDALONE

2

ST_HAST_PRIMARY

3

ST_HAST_BACKUP


 

mcSt has the following valid values:

Value

Description

0

ST_MCST_ISOLATED

1

ST-MCST_CONNECTED