Mtp3GetRouteCfg

Obtains the current route configuration values for the specified destination point code.

Prototype

MTP3_STATUS Mtp3GetRouteCfg ( U8 board, MTP3RouteCfg *pRouteCfg, U32 dpc, U32 opc)

Argument

Description

board

TX board number on which the desired MTP 3 task resides. This value must be from 1 through maxboard (currently 8).

pRouteCfg

Pointer to an MTP3RouteCfg structure where the current route configuration values are filled.

dpc

Destination point code associated with the route for which configuration information is obtained.

opc

Originating point code associated with the route for which configuration information is obtained.  If set to zero, MTP uses the OPC specified in the general configuration.


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 MTP3RouteCfg structure. Refer to Mtp3InitRouteCfg for more information about the MTP3RouteCfg structure.

See also

Mtp3GenStatus, Mtp3MgmtInit