Mtp3GetGenCfg

Obtains the current values of the general configuration parameters in the MTP 3 task.

Prototype

MTP3_STATUS Mtp3GetGenCfg ( U8 board, MTP3GenCfg *pGenCfg)

Argument

Description

board

TX board number on which the desired MTP 3 task resides. Valid range is 1 through maxboard (currently 8).

pGenCfg

Pointer to an MTP3GenCfg structure to be filled in by the MTP 3 task.


Return values

Return value

Description

MTP3_SUCCESS

 

MTP3_BOARD

Invalid board number.

MTP3_HANDLE

Mtp3MgmtInit not called for the specified board.

MTP3_TIMEOUT

No response from the board.


Details

This function can be called any time after Mtp3MgmtInit. The application must provide a pointer to a buffer large enough to hold the MTP3GenCfg structure. Refer to Mtp3InitGenCfg for more information about the MTP3GenCfg structure.

See also

Mtp3GenStatus, Mtp3InitGenCfg, Mtp3MgmtInit