PxMbxGetName()

Return the name of an object.

APPLIES TO

1.0.0

SYNOPSIS
PxError_t PxMbxGetName (PxMbx_t mbx, PxChar_t *buffer, PxUInt_t bufsize);
ARGUMENTS






mbx




The mailbox id


















buffer




Data area used to copy the mailbox (Mbx) object name to.


















bufsize




The length of the mailbox (Mbx) object name.

















RETURN VALUES






    

  • 

    PXERR_NOERROR if successful, or a PXROS-HR error code otherwise.
    

    • 







ERROR CODES















PXERR_NAME_BUFOVERFLOW




The data area is too short to store the objects name








PXERR_OBJ_ILLOBJ




mbx is not a valid object id








PXERR_PROT_PERMISSION




The data area is not writable for the calling task








PXERR_GLOBAL_ILLEGAL_CORE




The requested object is not on the same core








PXERR_SERVICE_NOT_CONFIGURED




Service has not been configured









DESCRIPTION










PxMbxGetName copies the name of mbx into the buffer buffer of length bufsize. The result is zero-terminated.



























SEE ALSO