Logo
UNICENS V2.1.0-3491
User Manual and API Reference
Ucs_Cmd_Return_t Ucs_Cmd_DecodeMsg ( Ucs_Inst_t self,
Ucs_AmsRx_Msg_t msg_rx_ptr 
)

Decode an MCM message.

Function expects that the MessageId Table ends with a termination entry (handler_function_ptr == NULL). If this entry is not present, the search may end in an endless loop.

Parameters
selfPointer to the Ucs instance
msg_rx_ptrReference to the message to decode
Returns
Possible return values are shown in the table below.
Value Description
UCS_CMD_RET_SUCCESS Decoding was successful
UCS_CMD_RET_ERR_MSGID_NOTAVAIL MessageId not found
UCS_CMD_RET_ERR_TX_BUSY No Tx Buffer available
UCS_CMD_RET_ERR_APPL Error happened in handler function
UCS_CMD_RET_ERR_NULL_PTR NULL pointer used as argument for message reference or MessageId Table not available.