PxToSetName()

Assign a name to an object.

APPLIES TO

1.0.0

SYNOPSIS
PxError_t PxToSetName (PxTo_t to, const 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_GLOBAL_ILLEGAL_CORE




The requested object is not on the same core








PXERR_NAME_BUFOVERFLOW




The name has been truncated








PXERR_OBJ_ILLOBJ




The passed object handle is not valid








PXERR_PROT_PERMISSION




The name is not readable for the calling task








PXERR_SERVICE_NOT_CONFIGURED




Service has not been configured








PXERR_ILLEGAL_ACCESS




Access through parameter pointer in size is illegal









DESCRIPTION










PxToSetName assigns the name to the object with handle to.














PxToSetName is the specialized version of PxObjSetName applicable to timeout objects.



























SEE ALSO