PxOpoolSetName()

Assign a name to an object pool.

APPLIES TO

1.0.0

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






opool




The object pool to which the name will be set


















buffer




Pointer to C string to be copied to the object’s name


















bufsize




Length of C string including the null character

















RETURN VALUES






    

  • 

    PXROS-HR error code
    

    • 







ERROR CODES















PXERR_NAME_BUFOVERFLOW




The name has been truncated








PXERR_PROT_PERMISSION




The name is not readable 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










PxOpoolSetName assigns a name to the object pool opool by copying bufsize characters from memory pointed to by buffer. If the bufzise is grater than the internal buffer for the object name, the name is truncated. The name is null terminated.



























SEE ALSO











USAGE








#include "pxdef.h"

const char opoolName[13] = "OBJPOOL-NAME"; // 12 characters + zero-terminator

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

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

char retOpoolName[13];

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

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