isupGetGenCfg

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

Prototype

short isupGetGenCfg ( U8 board, IsupGenParms *cfg)

Argument

Description

board

TX board number.

cfg

Pointer to the IsupGenParms structure where the requested configuration information is returned. Refer to isupInitGenCfg for the structure definition.


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;
U8            boardNum = 1;
IsupGenParms  cfg;

if ((status = isupGetGenCfg(boardNum, &cfg)) != ISUP_MGMT_SUCCESS)
{
    printf( "Board %d Send General Configuration Request failed: status = %d\n",
        boardNum, status );
}
else
    printf( “Successfully sent general configuration information to board %d\n",
        boardNum );
/* The cfg structure contains the returned general configuration information */

}