Query

cuest.bindings.cuestQuery(

*,

handle: cuest.bindings.cuest.cuestHandle,

type: cuest.bindings.cuest.CuestType,

object: object,

attribute: int,

attributeValue: object,

) → cuest.bindings.cuest.CuestStatus

Query an attribute of a cuEST opaque handle.

The result pointer ( attributeValue ) must reference sufficient memory for the type matching the specified attribute.

Parameters

handle[in]cuestHandle

cuEST handle. Must not be NULL.

type[in]cuestTypeHandle

enum indicating which type of object is being queried

object[in] :

cuEST object to be queried (opaque handle). Must not be NULL.

attribute[in]int

Attribute/property to query. (Should be an enum appropriate to the type of object.)

attributeValue[out] :

Pointer to memory for result (type depends on attribute).

Returns

status[out]cuestStatus_t

• CUEST_STATUS_SUCCESS on success;

• CUEST_STATUS_NULL_POINTER if attributeValue is NULL;

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

• CUEST_STATUS_INVALID_TYPE if attributeValue has the wrong data type;

• CUEST_STATUS_INVALID_ATTRIBUTE if attribute is not recognized;

• CUEST_STATUS_EXCEPTION or CUEST_STATUS_UNKNOWN_ERROR otherwise.