PxMbxRegisterMbx()
Register an application-specific server mailbox.
- APPLIES TO
-
1.0.0
- SYNOPSIS
-
PxError_t PxMbxRegisterMbx (PxMbxReq_t mbxreqid, PxMbx_t mbxid);
- ARGUMENTS
|
|
|
- RETURN VALUES
-
-
PXROS error code
-
- ERROR CODES
-
PXERR_MBX_ILLMBX
The given mailbox is an illegal mailbox object
PXERR_NAME_ILL_REQUEST
The
mbxreqid
is not known or the task is not allowed to do this call - DESCRIPTION
-
PxMbxRegisterMbx registers an application-specific mailbox id (mbxid) for a defined system service (mbxreqid).
- IMPLEMENTATION GUIDELINES
-
- Before call
-
-
mbxreqid
must be a valid PXROS-HR service mailbox (V).mbxid
must be a valid mailbox object (V).
-
- After call
-
-
The function returns
PXERR_NOERROR
if the mailbox could be registered for the service mailbox. Any other return value describes an error, which has to be interpreted (C).
-
- Best Practice
-
-
No restrictions
-
- SEE ALSO
- USAGE
-
#include "pxdef.h" PxError_t Err = PxMbxRegisterMbx(mbxreqid, mbxid); if (Err != PXERR_NOERROR) { // Report error }