PxToGetName()

Return the name of a timout object.

APPLIES TO

1.0.0

SYNOPSIS
PxError_t PxToGetName (PxTo_t to, PxChar_t *buffer, PxUInt_t bufsize);
ARGUMENTS






to




The timeout object id


















buffer




Data area to copy the object’s name to


















bufsize




Size of data area

















RETURN VALUES






    

  • 

    PXROS error code
    

    • 







ERROR CODES















PXERR_NAME_BUFOVERFLOW




The data area is too short to store the objects name








PXERR_OBJ_ILLOBJ




to is not a valid object id








PXERR_PROT_PERMISSION




The data area is not writeable 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










PxToGetName copies the name of to into the buffer buffer of length bufsize. The result is zero-terminated.














PxToGetName is the specialized version of PxObjGetName applicable to timout objects.



























SEE ALSO