TCAPGetGenCfg

Retrieves the current values for the general configuration parameters from the TX board.

Prototype

S16 TCAPGetGenCfg ( U8 board, TcapGenCfg *cfg)

Argument

Description

board

TX board number to which this request is directed.

cfg

Pointer to the address of a general configuration parameters buffer. The buffer's format is specified in TCAPInitGenCfg.


Return values

Return value

Description

TCAP_SUCCESS

 

TCAPM_BOARD

board is out of range.

TCAPM_DRIVER

Error occurred accessing the driver.

TCAPM_FAILED

Task on the TX board reported a failure.

TCAPM_NULLPTR

Null pointer was specified for cfg.

TCAPM_TIMEOUT

Request timed out.

TCAPM_UNINIT

Application failed to call TCAPInitMgmtAPI prior to this call.