M3uaGetSctSapCfg

Obtains SCT SAP configuration parameter values from the M3UA layer.

Prototype

STATUS TXM3UAFUNC M3uaGetSctSapCfg ( U8 board, M3UASctSapCfg *pSctSapCfg, S16 suId)

Argument

Description

board

TX board number on which the desired M3UA layer resides. Valid range is 1 through MAXBOARD (currently 32).

pSctSapCfg

Pointer to the M3UASctSapCfg structure where the requested configuration information is returned. For information, see M3UASctSapCfg.

suId

M3UA identifier of the SCT SAP for which to obtain configuration information.


Return values

Return value

Description

M3UA_SUCCESS

 

M3UA_BOARD

Invalid board number.

M3UA_DRIVER

CPI driver error.

M3UA_HANDLE

M3UAMgmtInit was not called for the specified board.

M3UA_PARAM

Invalid parameter.

M3UA_RESPONSE

Incorrect response from the board.

M3UA_TIMEOUT

No response from the board.


Details

This function can be called any time after M3uaMgmtInit. An application must provide a pointer to a buffer large enough to hold the M3UASctSapCfg structure.

See also

M3uaInitSctSapCfg, M3uaSetSctSapCfg