PxMbxCheck()

Check the validity of a mailbox.

APPLIES TO

1.0.0

SYNOPSIS
PxBool_t PxMbxCheck (PxMbx_t mbxid);
ARGUMENTS






mbxid




The mailbox object

















RETURN VALUES






    

  • 

    True if mbxid is a mailbox object
    

    • 

  • 

    False if mbxid is not a mailbox object
    

    • 







DESCRIPTION










PxMbxCheck checks the validity of a mailbox object. The function returns true if the parameter is a valid mailbox object, else false.






















IMPLEMENTATION GUIDELINES
















Before call






    

  • 

    mbxid must be a valid PXROS-HR mailbox object created with a PxMbxRequest call or the task’s private mailbox (V). The validity of mbxid may also be checked by the PxMbxIsValid macro (F).
    

    • 



















After call






    

  • 

    No checks necessary.
    

    • 



















Best Practice






    

  • 

    No restrictions.
    

    • 






























USAGE








#include "pxdef.h"

PxBool_t Val = PxMbxCheck(mbxid)

if (Val == true) {
    // Handle mailbox object
}
else {
    // Report error
}