Results

cuest.bindings.cuestResultsCreate(

*,

resultsType: int,

outResults: cuest.bindings.cuest.Results,

) → cuest.bindings.cuest.CuestStatus

Create a new cuEST results object of the specified type.

Allocates and initializes an opaque results object of the type specified by resultsType. The created object is returned via outResults and must be destroyed with cuestResultsDestroy().

Parameters

resultsType[in]CuestResultsType

Type of results object to create (see cuestResultsType_t).

outResults[out]cuestResultsHandle

Pointer to receive allocated opaque results handle.

Returns

statuscuestStatus_t

• CUEST_STATUS_SUCCESS on success;

• CUEST_STATUS_NULL_POINTER if outResults is NULL;

• CUEST_STATUS_INVALID_TYPE if resultsType is invalid;

• CUEST_STATUS_EXCEPTION or CUEST_STATUS_UNKNOWN_ERROR otherwise.

cuest.bindings.cuestResultsDestroy(

*,

resultsType: int,

results: cuest.bindings.cuest.Results,

) → cuest.bindings.cuest.CuestStatus

Destroy a cuEST results object of the specified type.

Properly deallocates and cleans up resources for a results handle created by cuestResultsCreate().

Parameters

resultsType[in]CuestResultsType

Type of results object (must match the type used at creation).

results[in]cuestResultsHandle

Results handle to destroy. Must not be NULL.

Returns

statuscuestStatus_t

• CUEST_STATUS_SUCCESS on success;

• CUEST_STATUS_NULL_POINTER if results is NULL;

• CUEST_STATUS_INVALID_TYPE if resultsType does not match the actual type of results;

• CUEST_STATUS_EXCEPTION or CUEST_STATUS_UNKNOWN_ERROR otherwise.

cuest.bindings.cuestResultsQuery(

*,

resultsType: int,

results: cuest.bindings.cuest.Results,

attribute: int,

attributeValue: object,

) → cuest.bindings.cuest.CuestStatus

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

Parameters

resultsType[in]CuestResultsType

Type of results object being queried.

results[in]cuestResultsHandle

Opaque handle of the results 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

statuscuestStatus_t

• CUEST_STATUS_SUCCESS on success;

• CUEST_STATUS_NULL_POINTER if results or attributeValue is NULL;

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

• CUEST_STATUS_INVALID_SIZE if the size of attributeValue does not match the attribute type size;

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

• CUEST_STATUS_EXCEPTION or CUEST_STATUS_UNKNOWN_ERROR otherwise.