isupGetCircCfg

Sends a get configuration request to the TX board and blocks the calling application while waiting for a response. A board circuit configuration is returned. The received configuration parameters are placed in the configuration buffer supplied by the application.

Prototype

short isupGetCircCfg ( U8 board, IsupCircCfg *cfg, U32 circuitId)

Argument

Description

board

TX board number.

cfg

Pointer to the IsupCircCfg structure where the requested configuration information is returned. Refer to isupInitCircCfg for the structure definition.

circuitId

Circuit ID number to use.


Return values

Return value

Description

ISUP_SUCCESS

 

ISUP_BOARD

board is out of range.

ISUP_DRIVER

Error occurred accessing the driver.

ISUP_FAILED

Task on the TX board returned a failure.

ISUP_UNBOUND

Application failed to call isupInitMgmtAPI prior to this call.


Example

S16          status;
8            boardNum=1;
IsupCircCfg  cfg;
U32          circuitId=1;

if ((status = isupGetCircCfg(boardNum, &cfg, circuitId)) != ISUP_MGMT_SUCCESS)
{
    printf( "Board %d Circuit %d Get Configuration Request failed: status = %d\n",
        boardNum, circuitId, status );
}
else
{
    printf("Successfully obtained configuration information for circuit %d on
        board %d\n", circuitId, boardNum);

  /* The cfg structure contains the circuit configuration information */

}