Parameters#

cuest.bindings.cuestParametersCreate(
*,
parametersType: cuest.bindings.cuest.CuestParametersType,
outParameters: cuest.bindings.cuest.Parameters,
) → cuest.bindings.cuest.CuestStatus#

Create a new cuEST parameters object of the specified type.

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

Parameters#

parametersType[in]CuestParametersType

Type of parameters object to create (see cuestParametersType_t).

outParameters[out] :

Pointer to receive allocated opaque parameters handle.

Returns#

status[out]cuestStatus_t
cuest.bindings.cuestParametersDestroy(
*,
parametersType: cuest.bindings.cuest.CuestParametersType,
parameters: cuest.bindings.cuest.Parameters,
) → cuest.bindings.cuest.CuestStatus#

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#

parametersType[in]CuestParametersType

Type of parameters object (must match creation).

parameters[in] :

Opaque parameters handle to destroy; must not be NULL.

Returns#

status[out]cuestStatus_t
cuest.bindings.cuestParametersQuery(
*,
parametersType: cuest.bindings.cuest.CuestParametersType,
parameters: cuest.bindings.cuest.Parameters,
attribute: int,
attributeValue: object,
) → cuest.bindings.cuest.CuestStatus#

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 parametersType. The result is placed in attributeValue, whose size must match the expected value size.

Parameters#

parametersType[in]CuestParametersType

Type of parameters object being queried.

parameters[in] :

Opaque handle of the parameters object (must not be NULL).

attribute[in]int

Integer attribute identifier (cast to appropriate attribute enum internally).

attributeValue[out] :

Destination for the queried value (must not be NULL).

Returns#

status[out]cuestStatus_t
cuest.bindings.cuestParametersConfigure(
*,
parametersType: cuest.bindings.cuest.CuestParametersType,
parameters: cuest.bindings.cuest.Parameters,
attribute: int,
attributeValue: object,
) → cuest.bindings.cuest.CuestStatus#

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 parametersType. The input value is provided as a pointer, and its size must match the expected storage for the attribute.

Parameters#

parametersType[in]CuestParametersType

Type of parameters object being queried.

parameters[out] :

Opaque handle of the parameters object (must not be NULL).

attribute[in]int

Integer attribute identifier (cast to appropriate attribute enum internally).

attributeValue[in] :

Pointer to the new value (must not be NULL).

Returns#

status[out]cuestStatus_t