PxMbxRequestMbx()

Request an application-specific server mailbox.

APPLIES TO

1.0.0

SYNOPSIS
PxMbx_t PxMbxRequestMbx (PxMbxReq_t mbxreqid);
ARGUMENTS






mbxreqid




The requested id of the requested server mailbox

















RETURN VALUES






    

  • 

    Mailbox id of the requested mailbox if available
    

    • 

  • 

    Invalid mailbox id if mailbox is not available
    

    • 







DESCRIPTION










PxMbxRequestMbx requests an application-specific mailbox id that has been assigned before for a defined system service (mbxreqid) by PxMbxRegisterMbx.






















IMPLEMENTATION GUIDELINES
















Before call






    

  • 

    mbxreqid must be a valid PXROS-HR service mailbox (V).
    

    • 



















After call






    

  • 

    The function returns the requested service mailbox. This mailbox id may be checked with one of the following macros:
    

    

      

    • 

      PxMbxIdIsValid() must be true.
      

      • 

    • 

      PxMbxIdGet() must not be _PXIllegalObjId.
      

      • 

    

    

    • 



















Best Practice






    

  • 

    No restrictions
    

    • 






























SEE ALSO











USAGE








#include "pxdef.h"

PxMbx_t mbx = PxMbxRequestMbx(mbxreqid);

if (!PxMbxIdIsValid(mbx)) {
    // Report error
}