Function GenieDialog_getValue

Function Documentation

Genie_Status_t GenieDialog_getValue(const GenieDialog_Handle_t dialogHandle, const GenieDialog_Param_t key, Genie_AllocCallback_t callback, Genie_DataType_t *dataType, Genie_Value_t *value)

A function to get a parameter or state variable from a dialog.

Parameters

  • dialogHandle – [in] The dialog handle.

  • key – [in] An enum key indicating which value is to be returned.

  • callback – [in] A callback function for allocating string types. Must not be NULL when dataType can be GENIE_DATATYPE_STRING.

  • dataType – [out] The data type of the value.

  • value – [out] The value corresponding to key. See dataType for which union member is to be accessed.

Returns

Status code:

  • GENIE_STATUS_SUCCESS: API call was successful.

  • GENIE_STATUS_ERROR_INVALID_ARGUMENT: At least one argument is invalid.

  • GENIE_STATUS_ERROR_INVALID_HANDLE: Dialog handle is invalid.

Note

Mapping of GenieDialog_Param_t keys to Genie_Value_t data types: GENIE_DIALOG_PARAM_CONTEXT_OCCUPANCY -> GENIE_DATATYPE_UINT_32