PxDelayGetName()

Return the name of an object.

APPLIES TO

8.2.0

SYNOPSIS
PxError_t PxDelayGetName (PxDelay_t delay, PxChar_t *buffer, PxUInt_t bufsize);
ARGUMENTS
delay

The delay’s id

buffer

Data area to copy the object name to

bufsize

The length of the delay 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

delay 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

PxDelayGetName copies the name of the given delay type object into the buffer buffer, which has a length of bufsize. The resulting string is zero-terminated.