PxPeGetName()

Return the name of a periodic object.

APPLIES TO

1.0.0

SYNOPSIS
PxError_t PxPeGetName (PxPe_t pe, PxChar_t *buffer, PxUInt_t bufsize);
ARGUMENTS






pe




The periodic object whose name will be returned


















buffer




Pointer to data area to copy the object’s name to


















bufsize




Size of data area

















RETURN VALUES






    

  • 

    PXROS-HR error code
    

    • 







ERROR CODES















PXERR_NAME_BUFOVERFLOW




The data area is too short to store the object’s name








PXERR_PROT_PERMISSION




The data area is not writeable for the calling task








PXERR_SERVICE_NOT_CONFIGURED




Service has not been configured








PXERR_OBJ_ILLOBJ




The passed periodic object handle is not valid








PXERR_GLOBAL_ILLEGAL_CORE




The periodic object is not on the same core









DESCRIPTION










PxPeGetName retrieves the name of the periodic object pe by copying characters into the buffer of length bufsize. The result is null-terminated.



























SEE ALSO











USAGE








#include "pxdef.h"

const char peName[18] = "PERIODIC-OBJ-NAME"; // 17 characters + null character

PxError_t err = PxPeSetName(pe, peName, 18);

if (err != PXERR_NOERROR) {
    // Report error
}

char retPeName[18];

PxError_t err = PxPeGetName(pe, retPeName, 18);

if (err != PXERR_NOERROR) {
    // Report error
}