TUPGetGrpStatus

Argument

Description

board

TX board number.

grpID

Group from which to retrieve status.

status

Pointer to the following structure in which to place the retrieved status:

typedef struct _TupGrpStatus
                     /* TUP Group status                       */
{
    DateTime dt;     /* date and time (Not Used)               */
    U32 altOpc       /* originating point code                 */
    U32 dpc;         /* destination point code                 */
    U16 cic;         /* starting CIC                           */
    U8 range;        /* range value, 0 if predefined           */
    U8 fill;         /* unused                                 */
    U16 count;       /* number of circuits in group            */
    U8 ocHMask[32];  /* status mask of local h/w block         */
    U8 ocMMask[32];  /* status mask of local maintenance block */
    U8 ocSMask[32];  /* status mask of local s/w block         */
    U8 remHMask[32]; /* status mask of local h/w block         */
    U8 remMMask[32]; /* status mask of local maintenance block */
    U8 remSMask[32]; /* status mask of local s/w block         */
} TupGrpStatus;

Return value

Description

TUP_SUCCESS

TUP_BOARD

board is out of range.

TUP_DRIVER

Error occurred accessing the driver.

TUP_FAILED

Task on the TX board reported a failure.

TUP_UNBOUND

Application failed to call TUPInitMgmtAPI prior to this call.