Mtp3GetLinkCfg

Obtains the current data link configuration values of the specified link number.

Prototype

MTP3_STATUS Mtp3GetLinkCfg ( U8 board, MTP3LinkCfg *pLinkCfg, S16 linkNo)

Argument

Description

board

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

pLinkCfg

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

linkNo

Link number for which to obtain configuration information.


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. An application must provide a pointer to a buffer large enough for the MTP3LinkCfg structure. Refer to Mtp3InitLinkCfg for more information about the MTP3LinkCfg structure.

See also

Mtp3GenStatus, Mtp3MgmtInit