Mtp2GetLinkCfg

Obtains the current configuration values of the specified link number.

Prototype

MTP2_STATUS Mtp2GetLinkCfg (U8 board, MTP2LinkCfg *pLinkCfg, S16 linkNo)

Argument

Description

board

TX board number on which the desired MTP 2 task resides.

pLinkCfg

Pointer to an MTP2LinkCfg structure where the data link configuration values are filled.

linkNo

Link number for which to obtain configuration information (0 through maximum number of links minus1).


Return values

Return value

Description

MTP2_SUCCESS

 

MTP2_BOARD

Invalid board number.

MTP2_HANDLE

Mtp2MgmtInit never called for specified board.

MTP2_TIMEOUT

No response from board.


Details

This function obtains the current data link configuration parameters of the specified link on the specified board. An application must provide a pointer to a buffer large enough for the MTP2LinkCfg structure. This function can be called any time after Mtp2MgmtInit.

Refer to Mtp2InitLinkCfg for more information on the MTP2LinkCfg structure.

See also

Mtp2InitLinkCfg, Mtp2MgmtInit