Mtp3SetRouteCfg

Configures the MTP 3 task with the route configuration values contained in the provided MTP3RouteCfg structure.

Prototype

MTP3_STATUS Mtp3SetRouteCfg ( U8 board, MTP3RouteCfg *pRouteCfg)

Argument

Description

board

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

pRouteCfg

Pointer to the MTP3RouteCfg structure containing the route configuration values.


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

An application must set the field values in the MTP3RouteCfg structure before calling this function. Set the values by calling Mtp3InitRouteCfg, by setting each field from within the application, or with a combination of the two (calling Mtp3InitRouteCfg and overriding specific fields before passing the MTP3RouteCfg structure to this function).

This function is typically called once for each configured route.

See also

Mtp3InitRouteCfg, Mtp3MgmtInit