Parameters#

group Parameters

Functions

cuestStatus_t cuestParametersCreate(
cuestParametersType_t parameterType,
void **outParameters
)#

Create a new cuEST parameters object of the specified type.

Allocates and initializes an opaque parameter object of the type specified by parameterType. The created object is returned via outParameters and must be destroyed with cuestParametersDestroy.

Parameters:

  • parameterType – [in] Type of parameters object to create (see cuestParametersType_t).

  • outParameters – [out] Pointer to receive allocated opaque parameters handle.

Returns:

  • CUEST_STATUS_SUCCESS on success;

  • CUEST_STATUS_NULL_POINTER if any required pointer is NULL;

  • CUEST_STATUS_INVALID_TYPE if opaque handles are not the correct type.

  • CUEST_STATUS_EXCEPTION or CUEST_STATUS_UNKNOWN_ERROR otherwise.

cuestStatus_t cuestParametersDestroy(
cuestParametersType_t parameterType,
void *parameters
)#

Destroy and free a cuEST parameters object of the specified type.

Properly deallocates and cleans up resources for a parameters handle created by cuestParametersCreate.

Parameters:

  • parameterType – [in] Type of parameters object (must match creation).

  • parameters – [in] Opaque parameters handle to destroy; must not be NULL.

Returns:

  • CUEST_STATUS_SUCCESS on success;

  • CUEST_STATUS_NULL_POINTER if any required pointer is NULL;

  • CUEST_STATUS_INVALID_TYPE if opaque handles are not the correct type.

  • CUEST_STATUS_EXCEPTION or CUEST_STATUS_UNKNOWN_ERROR otherwise.

cuestStatus_t cuestParametersQuery(
cuestParametersType_t parameterType,
const void *parameters,
int attribute,
void *attributeValue,
size_t attributeValueSize
)#

Query the value of a given attribute from a cuEST parameters object.

Retrieves the value associated with an attribute for the given parameters object. The type and meaning of attribute and attributeValue depend on parameterType. The result is placed in attributeValue, whose size must match the expected value size.

Parameters:

  • parameterType – [in] Type of parameters object being queried.

  • parameters – [in] Opaque handle of the parameters object (must not be NULL).

  • attribute – [in] Integer attribute identifier (cast to appropriate attribute enum internally).

  • attributeValue – [out] Destination for the queried value (must not be NULL).

  • attributeValueSize – [in] Size in bytes of attributeValue buffer (must match queried type).

Returns:

  • CUEST_STATUS_SUCCESS on success;

  • CUEST_STATUS_NULL_POINTER if any required pointer is NULL;

  • CUEST_STATUS_INVALID_TYPE if opaque handles are not the correct type.

  • CUEST_STATUS_INVALID_PARAMETER if parameterType is not the correct type.

  • CUEST_STATUS_EXCEPTION or CUEST_STATUS_UNKNOWN_ERROR otherwise.

cuestStatus_t cuestParametersConfigure(
cuestParametersType_t parameterType,
void *parameters,
int attribute,
const void *attributeValue,
size_t attributeValueSize
)#

Configure the value of a given attribute for a cuEST parameters object.

Sets or updates the value of an attribute for the given parameters object. The type and semantics of the attribute and attributeValue depend on parameterType. The input value is provided as a pointer, and its size must match the expected storage for the attribute.

Parameters:

  • parameterType – [in] Type of parameters object to configure.

  • parameters – [out] Opaque handle to parameters object (must not be NULL).

  • attribute – [in] Integer attribute identifier (cast to appropriate attribute enum internally).

  • attributeValue – [in] Pointer to the new value (must not be NULL).

  • attributeValueSize – [in] Size in bytes of attributeValue (must match attribute type).

Returns:

  • CUEST_STATUS_SUCCESS on success;

  • CUEST_STATUS_NULL_POINTER if any required pointer is NULL;

  • CUEST_STATUS_INVALID_TYPE if opaque handles are not the correct type.

  • CUEST_STATUS_INVALID_PARAMETER if parameterType is not the correct type.

  • CUEST_STATUS_EXCEPTION or CUEST_STATUS_UNKNOWN_ERROR otherwise.