isupTraceControl

Sends a request to control what is saved to the trace log and blocks the calling application while waiting for a response.

Prototype

short isupTraceControl ( U8 board, Bool onOff, U32 flags)

Argument

Description

board

TX board number.

onOff

Tracing is on if non-zero. Tracing is off if zero.

flags

Bit map (set of bits) that indicates what type of tracing is performed. Refer to the Details section for more information.


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

Supported values for types of tracing that can be combined using the OR operation into flags include:

Value

Description

TRACE_DATA

Protocol data tracing.

TRACE_EVENT

Event tracing.

ENCODE_ERROR

Alarm of message encode errors.

ENUM_WARNING

Alarm of enumeration warnings. ISUP checks values for most fields while encoding or decoding messages. An enumeration warning is generated when a field value is encountered that is not explicitly defined in the protocol specification for the configured switch type.


Example

S16    status;
U8     board = 1;

if ((status = isupTraceControl(board, 1, TRACE_DATA | TRACE_EVENT)) 
      != ISUP_MGMT_SUCCESS)
    printf( "Board %d Trace Control Request failed: status = %d\n",
       board, status );
}