PxOpoolGetName()

Return the name of an object pool.

APPLIES TO

1.0.0

SYNOPSIS
PxError_t PxOpoolGetName (PxOpool_t opool, PxChar_t *buffer, PxUInt_t bufsize);
ARGUMENTS






opool




The object pool 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 object pool handle is not valid








PXERR_GLOBAL_ILLEGAL_CORE




The object pool is not on the same core









DESCRIPTION










PxOpoolGetName retrieves the name of the object pool opool by copying characters into the buffer of length bufsize. The result is null-terminated.



























SEE ALSO











USAGE








#include "pxdef.h"

const char opoolName[13] = "PERIODIC-OBJ-NAME"; // 12 characters + null character

PxError_t err = PxOpoolSetName(opool, opoolName, 13);

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

char retOpoolName[13];

PxError_t err = PxOpoolGetName(opool, opoolName, 13);

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