PxMsgGetMetadata_Hnd()

Get the metadata of the message.

APPLIES TO

1.0.0

SYNOPSIS
PxMsgMetadata_t PxMsgGetMetadata_Hnd (PxMsg_t msgid);
ARGUMENTS






msgid




The message object

















ERROR CODES















PXERR_MSG_NOT_IMPLEMENTED




function is called by a system interrupt handler









DESCRIPTION










The PxMsgGetMetadata_Hnd returns the metadata of the message. The size of the metadata is 8 byte. This function should only be called from handlers running in a task’s context.






















IMPLEMENTATION GUIDELINES
















Before call






    

  • 

    msgid must be a valid message object, requested via PxMsgRequest…​ or PxMsgEnvelop…​ or received by a PxMsgReceive…​ call (V). This message object may be checked with one of the following macros:
    

    

      

    • 

      PxMsgIdIsValid() must be true.
      

      • 

    • 

      PxMsgIdGet() must not be _PXIllegalObjId.
      

      • 

    • 

      PxMsgIdError() must be PXERR_NOERROR otherwise the returned error code has to be interpreted (C).
      

      • 

    

    

    • 



















After call






    

  • 

    PxMsgGetMetadata_Hnd returns a null value on failure (C).
    

    • 



















Best Practice






    

  • 

    This function should be called from handlers only. (V)
    

    • 






























SEE ALSO











USAGE








#include "pxdef.h"

PxMsgMetadata_t MetaData = PxMsgGetMetaData_Hnd(msgid);