Mtp3GetLinkSetCfg

Obtains the current configuration values of the specified linkset.

Prototype

MTP3_STATUS Mtp3GetLinkSetCfg ( U8 board, MTP3LinkSetCfg *pLinkSetCfg, S16 linkSetNo)

Argument

Description

board

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

pLinkSetCfg

Pointer to an MTP3LinkSetCfg structure where the linkset configuration values are filled.

linkSetNo

Linkset number from 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 to hold the MTP3LinkSetCfg structure. Refer to Mtp3InitLinkSetCfg for more information about the MTP3LinkSetCfg structure.

See also

Mtp3GenStatus, Mtp3MgmtInit