PxMsgSetMetadata_Hnd()
Set the metadata for the message (handler service).
- APPLIES TO
-
8.2.0
- SYNOPSIS
-
PxError_t PxMsgSetMetadata_Hnd (PxMsg_t msgid, PxMsgMetadata_t metadata);
- ARGUMENTS
|
|
|
- ERROR CODES
-
PXERR_MSG_ILLMSG
msgid
is not a valid message objectPXERR_MSG_ILLUSER
The calling task is not user of this message
PXERR_MSG_NOT_IMPLEMENTED
The function is called by a system interrupt handler
- DESCRIPTION
-
The PxMsgSetMetadata_Hnd sets the metadata for the message. The size of the metadata is 8 byte. The PxMsgSetMetadata_Hnd should only be called from handlers running in a task’s context.
- IMPLEMENTATION GUIDELINES
-
- Before call
-
-
msgid
must be a valid message object, requested viaPxMsgRequest…
orPxMsgEnvelop…
or received by aPxMsgReceive…
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 bePXERR_NOERROR
otherwise the returned error code has to be interpreted (C).
-
-
- After call
-
-
The function returns
PXERR_NOERROR
if the message’s metadata is set. Any other return value describes an error, which has to be interpreted (C).
-
- Best Practice
-
-
This function should be called from handlers only. (V)
-
- SEE ALSO
- USAGE
-
#include "pxdef.h" PxError_t Err = PxMsgSetMetadata_Hnd(msgid, metadata); if (Err != PXERR_NOERROR) { // Report error }