Parameters

cuest.bindings.cuestParametersCreate(

*,

parametersType: int,

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]cuestParametersHandle

Pointer to receive allocated opaque parameters handle.

Returns

status[out]cuestStatus_t

• CUEST_STATUS_SUCCESS on success;

• CUEST_STATUS_NULL_POINTER if outParameters is NULL;

• CUEST_STATUS_INVALID_TYPE if parametersType is invalid;

• CUEST_STATUS_EXCEPTION or CUEST_STATUS_UNKNOWN_ERROR otherwise.

cuest.bindings.cuestParametersDestroy(

*,

parametersType: int,

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]cuestParametersHandle

Opaque parameters handle to destroy; must not be NULL.

Returns

status[out]cuestStatus_t

• CUEST_STATUS_SUCCESS on success;

• CUEST_STATUS_NULL_POINTER if parameters is NULL;

• CUEST_STATUS_INVALID_TYPE if parametersType does not match the actual type of parameters;

• CUEST_STATUS_EXCEPTION or CUEST_STATUS_UNKNOWN_ERROR otherwise.

cuest.bindings.cuestParametersQuery(

*,

parametersType: int,

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]cuestParametersHandle

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

attribute[in]int

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

attributeValue[out]data handle (matching the queried attribute’s type)

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

Returns

status[out]cuestStatus_t

• CUEST_STATUS_SUCCESS on success;

• CUEST_STATUS_NULL_POINTER if parameters is NULL;

• CUEST_STATUS_INVALID_TYPE if parameters is not of the specified parametersType, or attributeValue has the wrong data type;

• CUEST_STATUS_INVALID_PARAMETER if the attribute is not recognized for the given parametersType;

• CUEST_STATUS_EXCEPTION or CUEST_STATUS_UNKNOWN_ERROR otherwise.

cuest.bindings.cuestParametersConfigure(

*,

parametersType: int,

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 configured.

parameters[in,out]cuestParametersHandle

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

attribute[in]int

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

attributeValue[in]data handle (matching the configured attribute’s type)

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

Returns

status[out]cuestStatus_t

• CUEST_STATUS_SUCCESS on success;

• CUEST_STATUS_NULL_POINTER if parameters is NULL;

• CUEST_STATUS_INVALID_TYPE if parameters is not of the specified parametersType, or attributeValue has the wrong data type;

• CUEST_STATUS_INVALID_PARAMETER if the attribute is not recognized for the given parametersType;

• CUEST_STATUS_EXCEPTION or CUEST_STATUS_UNKNOWN_ERROR otherwise.