isupGenCfg

Sends a general configuration buffer to the TX board and blocks the calling application while waiting for a response.

Prototype

short isupGenCfg ( U8 board, IsupGenParms *cfg)

Argument

Description

board

TX board number.

cfg

Pointer to the IsupGenParms structure to send. 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.


Details

An application must set the field values in the IsupGenParms structure before calling isupGenCfg. Set the values in any of the following ways:

Example

S16           status;
U8            boardNum = 1;
IsupGenParms  cfg;

/* Populate cfg structure before calling isupGenCfg function */

if ((status = isupGenCfg(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 );
}