# Common Types Common QAIRT types, error codes, and version macros. **Include:** `#include "QairtCommon.h"` Enums - enum Qairt\_DataType\_t - An enum to specify scalar data types. *Values:* - enumerator QAIRT\_DATATYPE\_INT\_2 = 0x0002 - 2-bit integer type - enumerator QAIRT\_DATATYPE\_INT\_4 = 0x0004 - 4-bit integer type - enumerator QAIRT\_DATATYPE\_INT\_8 = 0x0008 - 8-bit integer type - enumerator QAIRT\_DATATYPE\_INT\_16 = 0x0016 - 16-bit integer type - enumerator QAIRT\_DATATYPE\_INT\_32 = 0x0032 - 32-bit integer type - enumerator QAIRT\_DATATYPE\_INT\_64 = 0x0064 - 64-bit integer type - enumerator QAIRT\_DATATYPE\_UINT\_2 = 0x0102 - - enumerator QAIRT\_DATATYPE\_UINT\_4 = 0x0104 - - enumerator QAIRT\_DATATYPE\_UINT\_8 = 0x0108 - - enumerator QAIRT\_DATATYPE\_UINT\_16 = 0x0116 - - enumerator QAIRT\_DATATYPE\_UINT\_32 = 0x0132 - - enumerator QAIRT\_DATATYPE\_UINT\_64 = 0x0164 - - enumerator QAIRT\_DATATYPE\_FLOAT\_4 = 0x0204 - - enumerator QAIRT\_DATATYPE\_FLOAT\_8 = 0x0208 - - enumerator QAIRT\_DATATYPE\_FLOAT\_16 = 0x0216 - - enumerator QAIRT\_DATATYPE\_BFLOAT\_16 = 0x0226 - - enumerator QAIRT\_DATATYPE\_FLOAT\_32 = 0x0232 - - enumerator QAIRT\_DATATYPE\_FLOAT\_64 = 0x0264 - - enumerator QAIRT\_DATATYPE\_SFIXED\_POINT\_2 = 0x0302 - - enumerator QAIRT\_DATATYPE\_SFIXED\_POINT\_4 = 0x0304 - - enumerator QAIRT\_DATATYPE\_SFIXED\_POINT\_8 = 0x0308 - - enumerator QAIRT\_DATATYPE\_SFIXED\_POINT\_16 = 0x0316 - - enumerator QAIRT\_DATATYPE\_SFIXED\_POINT\_32 = 0x0332 - - enumerator QAIRT\_DATATYPE\_UFIXED\_POINT\_2 = 0x0402 - - enumerator QAIRT\_DATATYPE\_UFIXED\_POINT\_4 = 0x0404 - - enumerator QAIRT\_DATATYPE\_UFIXED\_POINT\_8 = 0x0408 - - enumerator QAIRT\_DATATYPE\_UFIXED\_POINT\_16 = 0x0416 - - enumerator QAIRT\_DATATYPE\_UFIXED\_POINT\_32 = 0x0432 - - enumerator QAIRT\_DATATYPE\_BOOL\_8 = 0x0508 - 8-bit boolean type, 0 = false, any non-zero value = true - enumerator QAIRT\_DATATYPE\_STRING = 0x0608 - - enumerator QAIRT\_DATATYPE\_UNDEFINED = 0x7FFFFFFF - - enum Qairt\_Priority\_t - Define Qairt Priority. *Values:* - enumerator QAIRT\_PRIORITY\_LOWEST = 25 - Usage of the priorities apart from QAIRT\_PRIORITY\_LOW may be restricted. - enumerator QAIRT\_PRIORITY\_LOW = [QAIRT\_PRIORITY\_LOWEST](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv4N16Qairt_Priority_t21QAIRT_PRIORITY_LOWESTE) - QAIRT\_PRIORITY\_LOW is always available for use. - enumerator QAIRT\_PRIORITY\_NORMAL\_LOW = 50 - Between Low and Normal priorities. - enumerator QAIRT\_PRIORITY\_NORMAL = 100 - Between Normal Low and Normal High priorities. - enumerator QAIRT\_PRIORITY\_DEFAULT = [QAIRT\_PRIORITY\_NORMAL](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv4N16Qairt_Priority_t21QAIRT_PRIORITY_NORMALE) - - enumerator QAIRT\_PRIORITY\_NORMAL\_HIGH = 150 - Between Normal and High Priorities. - enumerator QAIRT\_PRIORITY\_HIGH = 200 - Between Normal High and High Plus Priorities. - enumerator QAIRT\_PRIORITY\_HIGH\_PLUS = 300 - Between High and Critical Priorities. - enumerator QAIRT\_PRIORITY\_CRITICAL = 400 - Between High Plus and Critical Plus Priorities. - enumerator QAIRT\_PRIORITY\_CRITICAL\_PLUS = 500 - Highest available priority. - enumerator QAIRT\_PRIORITY\_HIGHEST = [QAIRT\_PRIORITY\_CRITICAL\_PLUS](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv4N16Qairt_Priority_t28QAIRT_PRIORITY_CRITICAL_PLUSE) - - enumerator QAIRT\_PRIORITY\_UNDEFINED = 0x7FFFFFFF - - enum Qairt\_Precision\_t - Define Qairt Precision. *Values:* - enumerator QAIRT\_PRECISION\_FLOAT32 = 0 - 32-bit floating point precision. - enumerator QAIRT\_PRECISION\_FLOAT16 = 1 - 16-bit floating point precision. - enumerator QAIRT\_PRECISION\_UNDEFINED = 0x7FFFFFFF - - enum QairtCommon\_Error\_t - An enum which defines error codes commonly used across API components. *Values:* - enumerator QAIRT\_COMMON\_MIN\_ERROR = 1000 - - enumerator QAIRT\_COMMON\_ERROR\_NOT\_SUPPORTED = 1000 - API or feature is not supported by implementation. - enumerator QAIRT\_COMMON\_ERROR\_MEM\_ALLOC = 1002 - Memory allocation related error. - enumerator QAIRT\_COMMON\_ERROR\_SYSTEM = 1003 - System level error, such as related to platform / OS services. - enumerator QAIRT\_COMMON\_ERROR\_INVALID\_ARGUMENT = 1004 - Invalid function argument. - enumerator QAIRT\_COMMON\_ERROR\_OPERATION\_NOT\_PERMITTED = 1005 - Illegal operation or sequence of operations. - enumerator QAIRT\_COMMON\_ERROR\_PLATFORM\_NOT\_SUPPORTED = 1006 - Attempt to use QAIRT API on an unsupported platform. - enumerator QAIRT\_COMMON\_ERROR\_SYSTEM\_COMMUNICATION = 1007 - Communication errors with platform / OS service (service is recoverable) - enumerator QAIRT\_COMMON\_ERROR\_INCOMPATIBLE\_BINARIES = 1008 - Loaded libraries are of incompatible versions. - enumerator QAIRT\_COMMON\_ERROR\_LOADING\_BINARIES = 1009 - Attempt to reload library already loaded in this process. - enumerator QAIRT\_COMMON\_ERROR\_RESOURCE\_UNAVAILABLE = 1010 - Resource allocation related error. - enumerator QAIRT\_COMMON\_ERROR\_SYSTEM\_COMMUNICATION\_FATAL = 1011 - Communication errors with platform / OS service (service is non-recoverable) - enumerator QAIRT\_COMMON\_ERROR\_INVALID\_HANDLE = 1012 - Invalid function argument. - enumerator QAIRT\_COMMON\_ERROR\_OUT\_OF\_RANGE = 1013 - - enumerator QAIRT\_COMMON\_ERROR\_GENERAL = 1100 - General error, which has not been identified as any other error type. - enumerator QAIRT\_COMMON\_MAX\_ERROR = 1999 - - enumerator QAIRT\_COMMON\_ERROR\_UNDEFINED = 0x7FFFFFFF - Typedefs - typedef uint64\_t Qairt\_Status\_t - Status returned by QAIRT API calls. Compare to QAIRT\_SUCCESS to test for success. - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*Qairt\_GetInterfaceFn\_t)(uint64\_t, void\*\*) - a typedef for a function to retrieve interface extensions from an existing interface. Defines - QAIRT\_SUCCESS 0 - - QAIRT\_SAFE\_CALL(iface\_ptr, member, ...) (((iface\_ptr) != NULL &&                                             \ (const char\*)&(iface\_ptr)->member + sizeof((iface\_ptr)->member) <= \ (const char\*)(iface\_ptr) + (iface\_ptr)->size &&                \ (iface\_ptr)->member != NULL)                                       \ ? (iface\_ptr)->member(\_\_VA\_ARGS\_\_)                              \ : (( [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#QairtCommon_8h_1ac85296950c93bd3cf1900acd02ecb9c5))[QAIRT\_COMMON\_ERROR\_NOT\_SUPPORTED](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#QairtCommon_8h_1a645ef8c2ccd17ec10eb35e8215f8efc8a9fb341715f674670023a470d0aca11c9))) - Call a function through a versioned QAIRT interface struct, returning QAIRT\_COMMON\_ERROR\_NOT\_SUPPORTED if the function is unavailable. QAIRT interface structs carry a `size` field reflecting how many bytes the library populated. This macro checks that the requested field lies within that reported size and is non-NULL before calling it, returning QAIRT\_COMMON\_ERROR\_NOT\_SUPPORTED otherwise. This guards against calling a function that does not exist in the loaded library without requiring a prior capability query, though [QairtInfo\_hasCapability()](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#QairtInfo_8h_1a9895a32c5ccaf9875e7ba1e5e6c6faf3) should still be used for semantic feature detection. The pointer-to-char casts used in the size check are permitted under the MISRA C:2012/C:2023 Rule 11.3 exception for conversions to char types. Example: if (QairtInfo_hasCapability(QAIRT_CAPABILITY_FOO) == QAIRT_CAPABILITY_SUPPORTED) { status = QAIRT_SAFE_CALL(fooInterface, someNewFunction, arg1, arg2); } Copy to clipboard - Parameters - - **iface\_ptr** – Pointer to a QAIRT interface struct (must not be NULL). - **member** – The function-pointer field to call (unquoted identifier). - **...** – Arguments forwarded verbatim to the function. - Returns - The return value of the function, or `QAIRT_COMMON_ERROR_NOT_SUPPORTED` if the function is unavailable. - QAIRT\_API - - QAIRT\_API\_VERSION\_MAJOR 0 - - QAIRT\_API\_VERSION\_MINOR 1 - - QAIRT\_API\_VERSION\_PATCH 0 - - QAIRT\_BACKEND\_ID\_NULL 0 - NULL backend identifier. - QAIRT\_MIN\_ID\_COMMON 1000 - - QAIRT\_MAX\_ID\_COMMON 1999 - - QAIRT\_MIN\_ID\_CAPABILITY 2000 - - QAIRT\_MAX\_ID\_CAPABILITY 2999 - - QAIRT\_MIN\_ID\_OP\_PACKAGE 3000 - - QAIRT\_MAX\_ID\_OP\_PACKAGE 3999 - - QAIRT\_MIN\_ID\_BACKEND 4000 - - QAIRT\_MIN\_ID\_BACKEND\_SAVER 4950 - - QAIRT\_MAX\_ID\_BACKEND\_SAVER 4998 - - QAIRT\_MAX\_ID\_BACKEND 4999 - - QAIRT\_MIN\_ID\_CONTEXT 5000 - - QAIRT\_MAX\_ID\_CONTEXT 5999 - - QAIRT\_MIN\_ID\_GRAPH 6000 - - QAIRT\_MAX\_ID\_GRAPH 6999 - - QAIRT\_MIN\_ID\_TENSOR 7000 - - QAIRT\_MAX\_ID\_TENSOR 7999 - - QAIRT\_MIN\_ID\_MEM 8000 - - QAIRT\_MAX\_ID\_MEM 8999 - - QAIRT\_MIN\_ID\_SIGNAL 9000 - - QAIRT\_MAX\_ID\_SIGNAL 9999 - - QAIRT\_MIN\_ID\_ERROR 10000 - - QAIRT\_MAX\_ID\_ERROR 10999 - - QAIRT\_MIN\_ID\_LOG 11000 - - QAIRT\_MAX\_ID\_LOG 11999 - - QAIRT\_MIN\_ID\_PROFILE 12000 - - QAIRT\_MAX\_ID\_PROFILE 12999 - - QAIRT\_MIN\_ID\_PERF\_INFRASTRUCTURE 13000 - - QAIRT\_MAX\_ID\_PERF\_INFRASTRUCTURE 13999 - - QAIRT\_MIN\_ID\_DEVICE 14000 - - QAIRT\_MAX\_ID\_DEVICE 14999 - - QAIRT\_MIN\_ID\_INFO 15000 - - QAIRT\_MAX\_ID\_INFO 15999 - - QAIRT\_MIN\_ID\_OPCONFIG 16000 - - QAIRT\_MAX\_ID\_OPCONFIG 16999 - - QAIRT\_MIN\_ID\_QUANTIZE\_PARAMS 17000 - - QAIRT\_MAX\_ID\_QUANTIZE\_PARAMS 17999 - - QAIRT\_MIN\_ID\_GLOBAL\_CONFIG 18000 - - QAIRT\_MAX\_ID\_GLOBAL\_CONFIG 18999 - - QAIRT\_MIN\_ID\_SYSTEM 30000 - - QAIRT\_MIN\_ID\_SYSTEM\_LOG 30100 - - QAIRT\_MIN\_ID\_SYSTEM\_DLC 35000 - - QAIRT\_MAX\_ID\_SYSTEM\_DLC 39999 - - QAIRT\_MIN\_ID\_SYSTEM\_PROFILE 40000 - - QAIRT\_MAX\_ID\_SYSTEM 49999 - - QAIRT\_MIN\_ID\_HTP 100000 - - QAIRT\_MAX\_ID\_HTP 199999 - - QAIRT\_MIN\_ID\_GPU 200000 - - QAIRT\_MAX\_ID\_GPU 299999 - - QAIRT\_MIN\_ID\_DSP 300000 - - QAIRT\_MAX\_ID\_DSP 399999 - - QAIRT\_MIN\_ID\_CPU 400000 - - QAIRT\_MAX\_ID\_CPU 499999 - - QAIRT\_MIN\_ID\_LPAI 500000 - - QAIRT\_MAX\_ID\_LPAI 599999 - - QAIRT\_MIN\_ERROR\_COMMON 1000 - - QAIRT\_MAX\_ERROR\_COMMON 1999 - - QAIRT\_MIN\_ERROR\_CAPABILITY 2000 - - QAIRT\_MAX\_ERROR\_CAPABILITY 2999 - - QAIRT\_MIN\_ERROR\_OP\_PACKAGE 3000 - - QAIRT\_MAX\_ERROR\_OP\_PACKAGE 3999 - - QAIRT\_MIN\_ERROR\_BACKEND 4000 - - QAIRT\_MIN\_ERROR\_BACKEND\_SAVER 4950 - - QAIRT\_MAX\_ERROR\_BACKEND\_SAVER 4998 - - QAIRT\_MAX\_ERROR\_BACKEND 4999 - - QAIRT\_MIN\_ERROR\_CONTEXT 5000 - - QAIRT\_MAX\_ERROR\_CONTEXT 5999 - - QAIRT\_MIN\_ERROR\_GRAPH 6000 - - QAIRT\_MAX\_ERROR\_GRAPH 6999 - - QAIRT\_MIN\_ERROR\_TENSOR 7000 - - QAIRT\_MAX\_ERROR\_TENSOR 7999 - - QAIRT\_MIN\_ERROR\_MEM 8000 - - QAIRT\_MAX\_ERROR\_MEM 8999 - - QAIRT\_MIN\_ERROR\_SIGNAL 9000 - - QAIRT\_MAX\_ERROR\_SIGNAL 9999 - - QAIRT\_MIN\_ERROR\_ERROR 10000 - - QAIRT\_MAX\_ERROR\_ERROR 10999 - - QAIRT\_MIN\_ERROR\_LOG 11000 - - QAIRT\_MAX\_ERROR\_LOG 11999 - - QAIRT\_MIN\_ERROR\_PROFILE 12000 - - QAIRT\_MAX\_ERROR\_PROFILE 12999 - - QAIRT\_MIN\_ERROR\_PERF\_INFRASTRUCTURE 13000 - - QAIRT\_MAX\_ERROR\_PERF\_INFRASTRUCTURE 13999 - - QAIRT\_MIN\_ERROR\_DEVICE 14000 - - QAIRT\_MAX\_ERROR\_DEVICE 14999 - - QAIRT\_MIN\_ERROR\_INTERFACE 15000 - - QAIRT\_MAX\_ERROR\_INTERFACE 15999 - - QAIRT\_MIN\_ERROR\_OPCONFIG 16000 - - QAIRT\_MAX\_ERROR\_OPCONFIG 16999 - - QAIRT\_MIN\_ERROR\_GLOBAL\_CONFIG 18000 - - QAIRT\_MAX\_ERROR\_GLOBAL\_CONFIG 18999 - - QAIRT\_MIN\_ERROR\_SYSTEM 30000 - - QAIRT\_MIN\_ERROR\_SYSTEM\_DLC 35000 - - QAIRT\_MAX\_ERROR\_SYSTEM\_DLC 39999 - - QAIRT\_MAX\_ERROR\_SYSTEM 49999 - - QAIRT\_MIN\_ERROR\_HTP 100000 - - QAIRT\_MAX\_ERROR\_HTP 199999 - - QAIRT\_MIN\_ERROR\_GPU 200000 - - QAIRT\_MAX\_ERROR\_GPU 299999 - - QAIRT\_MIN\_ERROR\_CPU 400000 - - QAIRT\_MAX\_ERROR\_CPU 499999 - - QAIRT\_MIN\_ERROR\_LPAI 500000 - - QAIRT\_MAX\_ERROR\_LPAI 599999 - - QAIRT\_MIN\_ERROR\_DSP 300000 - - QAIRT\_MAX\_ERROR\_DSP 399999 - * * * Error reporting configuration. **Include:** `#include "QairtErrorReportingConfig.h"` - struct QairtErrorReporting\_Config\_V1\_t - *#include <QairtErrorReportingConfig.h>* Public Members - uint64\_t size - - [Qairt\_GetInterfaceFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv422Qairt_GetInterfaceFn_t) getInterface - - [QairtErrorReporting\_Config\_CreateFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv437QairtErrorReporting_Config_CreateFn_t) create - - [QairtErrorReporting\_Config\_FreeFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv435QairtErrorReporting_Config_FreeFn_t) free - - [QairtErrorReporting\_Config\_GetReportingLevelFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv448QairtErrorReporting_Config_GetReportingLevelFn_t) getReportingLevel - - [QairtErrorReporting\_Config\_SetReportingLevelFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv448QairtErrorReporting_Config_SetReportingLevelFn_t) setReportingLevel - - [QairtErrorReporting\_Config\_GetStorageLimitFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv446QairtErrorReporting_Config_GetStorageLimitFn_t) getStorageLimit - - [QairtErrorReporting\_Config\_SetStorageLimitFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv446QairtErrorReporting_Config_SetStorageLimitFn_t) setStorageLimit - Functions - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtErrorReporting\_Config\_create([QairtErrorReporting\_Config\_Level\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_Config_Level_t) reportingLevel, uint32\_t storageLimit, [QairtErrorReporting\_ConfigHandle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_ConfigHandle_t) \*configHandle) - Create a handle to an error reporting config object. - Parameters - - **reportingLevel** – **[in]** Error reporting level to be used. - **storageLimit** – **[in]** Amount of memory to be reserved for error information. Specified in KB. - **configHandle** – **[out]** The created error reporting config handle. - Returns - Error code: - QAIRT\_SUCCESS: if error reporting config is successfully created. - QAIRT\_COMMON\_ERROR\_NOT\_SUPPORTED: error reporting config is not supported. - QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_INVALID\_ARGUMENT: if one or more arguments is invalid. - QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_MEM\_ALLOC: for memory allocation errors. - QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_INITIALIZATION: config init failed. - QAIRT\_COMMON\_ERROR\_SYSTEM\_COMMUNICATION: SSR occurence (successful recovery) - QAIRT\_COMMON\_ERROR\_SYSTEM\_COMMUNICATION\_FATAL: SSR occurence (unsuccessful recovery) Note Use corresponding API through [QairtErrorReporting\_Config\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtErrorReporting__Config__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtErrorReporting\_Config\_free([QairtErrorReporting\_ConfigHandle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_ConfigHandle_t) configHandle) - Frees an error reporting config handle. - Parameters - **configHandle** – **[in]** A handle to a created error reporting config. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered, config is freed. - QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_MEM\_ALLOC: error related to memory deallocation - QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_INVALID\_HANDLE: *configHandle* is not a valid handle Note Use corresponding API through [QairtErrorReporting\_Config\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtErrorReporting__Config__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtErrorReporting\_Config\_getReportingLevel([QairtErrorReporting\_ConfigHandle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_ConfigHandle_t) configHandle, [QairtErrorReporting\_Config\_Level\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_Config_Level_t) \*reportingLevel) - Get the reporting level from an error reporting config handle. - Parameters - - **configHandle** – **[in]** A created error reporting config handle. - **reportingLevel** – **[out]** The current reporting level. - Returns - Error code: - QAIRT\_SUCCESS: if the reporting level is retrieved successfully. - QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_INVALID\_ARGUMENT: if reportingLevel is NULL. - QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_INVALID\_HANDLE: *configHandle* is not a valid handle - QAIRT\_COMMON\_ERROR\_SYSTEM\_COMMUNICATION: SSR occurence (successful recovery) - QAIRT\_COMMON\_ERROR\_SYSTEM\_COMMUNICATION\_FATAL: SSR occurence (unsuccessful recovery) Note Use corresponding API through [QairtErrorReporting\_Config\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtErrorReporting__Config__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtErrorReporting\_Config\_setReportingLevel([QairtErrorReporting\_ConfigHandle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_ConfigHandle_t) configHandle, [QairtErrorReporting\_Config\_Level\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_Config_Level_t) reportingLevel) - Set the reporting level for an error reporting config handle. - Parameters - - **configHandle** – **[in]** A created error reporting config handle. - **reportingLevel** – **[in]** New reporting level. - Returns - Error code: - QAIRT\_SUCCESS: if the reporting level is set successfully. - QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_INVALID\_ARGUMENT: if reportingLevel is not a valid QairtErrorReporting\_Config\_Level\_t level. - QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_INVALID\_HANDLE: *configHandle* is not a valid handle - QAIRT\_COMMON\_ERROR\_SYSTEM\_COMMUNICATION: SSR occurence (successful recovery) - QAIRT\_COMMON\_ERROR\_SYSTEM\_COMMUNICATION\_FATAL: SSR occurence (unsuccessful recovery) Note Use corresponding API through [QairtErrorReporting\_Config\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtErrorReporting__Config__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtErrorReporting\_Config\_getStorageLimit([QairtErrorReporting\_ConfigHandle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_ConfigHandle_t) configHandle, uint32\_t \*storageLimit) - Get the storage limit from an error reporting config handle. - Parameters - - **configHandle** – **[in]** A created error reporting config handle. - **storageLimit** – **[out]** The current storage limit in KB. - Returns - Error code: - QAIRT\_SUCCESS: if the storage limit is retrieved successfully. - QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_INVALID\_ARGUMENT: if storageLimit is NULL. - QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_INVALID\_HANDLE: *configHandle* is not a valid handle - QAIRT\_COMMON\_ERROR\_SYSTEM\_COMMUNICATION: SSR occurence (successful recovery) - QAIRT\_COMMON\_ERROR\_SYSTEM\_COMMUNICATION\_FATAL: SSR occurence (unsuccessful recovery) Note Use corresponding API through [QairtErrorReporting\_Config\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtErrorReporting__Config__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtErrorReporting\_Config\_setStorageLimit([QairtErrorReporting\_ConfigHandle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_ConfigHandle_t) configHandle, uint32\_t storageLimit) - Set the storage limit for an error reporting config handle. - Parameters - - **configHandle** – **[in]** A created error reporting config handle. - **storageLimit** – **[in]** New storage limit in KB. - Returns - Error code: - QAIRT\_SUCCESS: if the storage limit is set successfully. - QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_INVALID\_ARGUMENT: if storageLimit is invalid. - QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_INVALID\_HANDLE: *configHandle* is not a valid handle - QAIRT\_COMMON\_ERROR\_SYSTEM\_COMMUNICATION: SSR occurence (successful recovery) - QAIRT\_COMMON\_ERROR\_SYSTEM\_COMMUNICATION\_FATAL: SSR occurence (unsuccessful recovery) Note Use corresponding API through [QairtErrorReporting\_Config\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtErrorReporting__Config__V1__t). Enums - enum QairtErrorReporting\_Config\_Error\_t - QAIRT Error Reporting Config API result / error codes. *Values:* - enumerator QAIRT\_ERROR\_REPORTING\_CONFIG\_MIN\_ERROR = QAIRT\_MIN\_ERROR\_ERROR - - enumerator QAIRT\_ERROR\_REPORTING\_CONFIG\_NO\_ERROR = QAIRT\_SUCCESS - Qairt Error Reporting Config success. - enumerator QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_MEM\_ALLOC = [QAIRT\_COMMON\_ERROR\_MEM\_ALLOC](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv4N19QairtCommon_Error_t28QAIRT_COMMON_ERROR_MEM_ALLOCE) - General error relating to memory allocation in Error Reporting Config API. - enumerator QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_INITIALIZATION = 10002 - Unable to initialize error reporting config. - enumerator QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_INVALID\_ARGUMENT = 10003 - Invalid argument passed. - enumerator QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_INVALID\_HANDLE = 10004 - Invalid error reporting config handle passed. - enumerator QAIRT\_ERROR\_REPORTING\_CONFIG\_MAX\_ERROR = QAIRT\_MAX\_ERROR\_ERROR - - enumerator QAIRT\_ERROR\_REPORTING\_CONFIG\_ERROR\_UNDEFINED = 0x7FFFFFFF - - enum QairtErrorReporting\_Config\_Level\_t - An enum to describe reporting levels for the error handling API QAIRT\_ERROR\_REPORTING\_LEVEL\_BRIEF: get basic information about an error QAIRT\_ERROR\_REPORTING\_LEVEL\_DETAILED: get detailed information about an error in memory-based object forms. *Values:* - enumerator QAIRT\_ERROR\_REPORTING\_LEVEL\_BRIEF = 0 - - enumerator QAIRT\_ERROR\_REPORTING\_LEVEL\_DETAILED = 1 - - enumerator QAIRT\_ERROR\_REPORTING\_LEVEL\_UNDEFINED = 0x7FFFFFFF - Typedefs - typedef struct \_QairtErrorReporting\_ConfigHandle\_t \*QairtErrorReporting\_ConfigHandle\_t - Error Reporting Config handle used to interface with Error Reporting Config APIs. The handle itself is created and freed by the client. Copy to clipboard - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtErrorReporting\_Config\_CreateFn\_t)([QairtErrorReporting\_Config\_Level\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_Config_Level_t), uint32\_t, [QairtErrorReporting\_ConfigHandle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_ConfigHandle_t)\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtErrorReporting\_Config\_FreeFn\_t)([QairtErrorReporting\_ConfigHandle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_ConfigHandle_t)) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtErrorReporting\_Config\_GetReportingLevelFn\_t)([QairtErrorReporting\_ConfigHandle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_ConfigHandle_t), [QairtErrorReporting\_Config\_Level\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_Config_Level_t)\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtErrorReporting\_Config\_SetReportingLevelFn\_t)([QairtErrorReporting\_ConfigHandle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_ConfigHandle_t), [QairtErrorReporting\_Config\_Level\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_Config_Level_t)) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtErrorReporting\_Config\_GetStorageLimitFn\_t)([QairtErrorReporting\_ConfigHandle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_ConfigHandle_t), uint32\_t\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtErrorReporting\_Config\_SetStorageLimitFn\_t)([QairtErrorReporting\_ConfigHandle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtErrorReporting_ConfigHandle_t), uint32\_t) - Defines - QAIRT\_ERROR\_REPORTING\_CONFIG\_V1\_ID QAIRT\_MIN\_ID\_ERROR - * * * Runtime information accessors. **Include:** `#include "QairtInfo.h"` - struct QairtInfo\_V1\_t - *#include <QairtInfo.h>* Public Members - uint64\_t size - - [Qairt\_GetInterfaceFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv422Qairt_GetInterfaceFn_t) getInterface - - [QairtInfo\_GetBackendApiVersionFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv434QairtInfo_GetBackendApiVersionFn_t) getBackendApiVersion - - [QairtInfo\_GetCoreApiVersionFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv431QairtInfo_GetCoreApiVersionFn_t) getCoreApiVersion - - [QairtInfo\_GetBuildIdFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv424QairtInfo_GetBuildIdFn_t) getBuildId - - [QairtInfo\_HasCapabilityFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv427QairtInfo_HasCapabilityFn_t) hasCapability - Functions - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtInfo\_getBackendApiVersion(uint32\_t \*major, uint32\_t \*minor, uint32\_t \*patch) - Gets the backend API version. Can be retrieved without creating a backend. - Parameters - - **major** – **[out]** The major version value - **minor** – **[out]** The minor version value - **patch** – **[out]** The patch version value - Returns - Error code: - QAIRT\_SUCCESS: no error is encountered - QAIRT\_COMMON\_ERROR\_INVALID\_ARGUMENT: if *major*,*minor*, or *patch* was NULL Note Use corresponding API through [QairtInfo\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtInfo__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtInfo\_getCoreApiVersion(uint32\_t \*major, uint32\_t \*minor, uint32\_t \*patch) - Gets the core API version. Can be retrieved without creating a backend. - Parameters - - **major** – **[out]** The major version value - **minor** – **[out]** The minor version value - **patch** – **[out]** The patch version value - Returns - Error code: - QAIRT\_SUCCESS: no error is encountered - QAIRT\_COMMON\_ERROR\_INVALID\_ARGUMENT: if *major*,*minor*, or *patch* was NULL Note Use corresponding API through [QairtInfo\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtInfo__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtInfo\_getBuildId(const char \*\*id) - Get build id for backend library. - Parameters - **id** – **[out]** Pointer to string containing the build id. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_COMMON\_ERROR\_NOT\_SUPPORTED: No build ID is available - QAIRT\_COMMON\_ERROR\_INVALID\_ARGUMENT: if *id* is NULL Note Safe to call any time, backend does not have to be created. Note Use corresponding API through [QairtInfo\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtInfo__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtInfo\_hasCapability(QairtCapability\_Key\_t key) - Queries a capability of the backend. - Parameters - **key** – **[in]** Key which identifies the capability within group. - Returns - Error code: - QAIRT\_CAPABILITY\_SUPPORTED: if the backend supports capability. - QAIRT\_CAPABILITY\_ERROR\_UNKNOWN\_KEY: The provided key is not valid. - QAIRT\_CAPABILITY\_NOT\_SUPPORTED: if the backend does not support capability. Note Safe to call any time, backend does not have to be created. Note Use corresponding API through [QairtInfo\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtInfo__V1__t). Enums - enum QairtCapability\_Error\_t - QAIRT API result / error codes. *Values:* - enumerator QAIRT\_CAPABILITY\_MIN\_ERROR = QAIRT\_MIN\_ERROR\_CAPABILITY - - enumerator QAIRT\_CAPABILITY\_NO\_ERROR = QAIRT\_SUCCESS - - enumerator QAIRT\_CAPABILITY\_SUPPORTED = QAIRT\_SUCCESS - Capability in question is supported. - enumerator QAIRT\_CAPABILITY\_NOT\_SUPPORTED = [QAIRT\_COMMON\_ERROR\_NOT\_SUPPORTED](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv4N19QairtCommon_Error_t32QAIRT_COMMON_ERROR_NOT_SUPPORTEDE) - Capability in question not supported. - enumerator QAIRT\_CAPABILITY\_ERROR\_UNKNOWN\_KEY = 2000 - Backend did not recognize the capability key. - enumerator QAIRT\_CAPABILITY\_MAX\_ERROR = QAIRT\_MAX\_ERROR\_CAPABILITY - - enumerator QAIRT\_CAPABILITY\_ERROR\_UNDEFINED = 0x7FFFFFFF - Typedefs - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtInfo\_GetBackendApiVersionFn\_t)(uint32\_t\*, uint32\_t\*, uint32\_t\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtInfo\_GetCoreApiVersionFn\_t)(uint32\_t\*, uint32\_t\*, uint32\_t\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtInfo\_GetBuildIdFn\_t)(const char\*\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtInfo\_HasCapabilityFn\_t)(QairtCapability\_Key\_t) - Defines - QAIRT\_INFO\_V1\_ID QAIRT\_MIN\_ID\_INFO - * * * Scalar value types. **Include:** `#include "QairtScalar.h"` - struct QairtScalar\_V1\_t - *#include <QairtScalar.h>* Public Members - uint64\_t size - - [Qairt\_GetInterfaceFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv422Qairt_GetInterfaceFn_t) getInterface - - [QairtScalar\_CreateFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv422QairtScalar_CreateFn_t) create - - [QairtScalar\_FreeFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_FreeFn_t) free - - [QairtScalar\_GetDataTypeFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv427QairtScalar_GetDataTypeFn_t) getDataType - - [QairtScalar\_GetFloatValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv429QairtScalar_GetFloatValueFn_t) getFloatValue - - [QairtScalar\_GetDoubleValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv430QairtScalar_GetDoubleValueFn_t) getDoubleValue - - [QairtScalar\_GetUint64ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv430QairtScalar_GetUint64ValueFn_t) getUint64Value - - [QairtScalar\_GetUint32ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv430QairtScalar_GetUint32ValueFn_t) getUint32Value - - [QairtScalar\_GetUint16ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv430QairtScalar_GetUint16ValueFn_t) getUint16Value - - [QairtScalar\_GetUint8ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv429QairtScalar_GetUint8ValueFn_t) getUint8Value - - [QairtScalar\_GetInt64ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv429QairtScalar_GetInt64ValueFn_t) getInt64Value - - [QairtScalar\_GetInt32ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv429QairtScalar_GetInt32ValueFn_t) getInt32Value - - [QairtScalar\_GetInt16ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv429QairtScalar_GetInt16ValueFn_t) getInt16Value - - [QairtScalar\_GetInt8ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv428QairtScalar_GetInt8ValueFn_t) getInt8Value - - [QairtScalar\_GetStringValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv430QairtScalar_GetStringValueFn_t) getStringValue - - [QairtScalar\_GetBoolValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv428QairtScalar_GetBoolValueFn_t) getBoolValue - - [QairtScalar\_SetFloatValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv429QairtScalar_SetFloatValueFn_t) setFloatValue - - [QairtScalar\_SetDoubleValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv430QairtScalar_SetDoubleValueFn_t) setDoubleValue - - [QairtScalar\_SetUint64ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv430QairtScalar_SetUint64ValueFn_t) setUint64Value - - [QairtScalar\_SetUint32ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv430QairtScalar_SetUint32ValueFn_t) setUint32Value - - [QairtScalar\_SetUint16ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv430QairtScalar_SetUint16ValueFn_t) setUint16Value - - [QairtScalar\_SetUint8ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv429QairtScalar_SetUint8ValueFn_t) setUint8Value - - [QairtScalar\_SetInt64ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv429QairtScalar_SetInt64ValueFn_t) setInt64Value - - [QairtScalar\_SetInt32ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv429QairtScalar_SetInt32ValueFn_t) setInt32Value - - [QairtScalar\_SetInt16ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv429QairtScalar_SetInt16ValueFn_t) setInt16Value - - [QairtScalar\_SetInt8ValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv428QairtScalar_SetInt8ValueFn_t) setInt8Value - - [QairtScalar\_SetStringValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv430QairtScalar_SetStringValueFn_t) setStringValue - - [QairtScalar\_SetBoolValueFn\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv428QairtScalar_SetBoolValueFn_t) setBoolValue - Functions - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_create([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) \*scalarHandle) - Create a scalar handle. - Parameters - **scalarHandle** – **[out]** A handle to the created scalar. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_ARGUMENT: *scalarHandle* is NULL - QAIRT\_OPCONFIG\_ERROR\_MEM\_ALLOC: Memory allocation error while creating scalar Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_free([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle) - Free a scalar handle. - Parameters - **scalarHandle** – **[in]** A handle to the scalar to be freed. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle - QAIRT\_OPCONFIG\_ERROR\_MEM\_ALLOC: Memory deallocation error Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_getDataType([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, [Qairt\_DataType\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv416Qairt_DataType_t) \*value) - Get the data type of a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[out]** The retrieved data type. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle - QAIRT\_OPCONFIG\_ERROR\_INVALID\_ARGUMENT: *value* is NULL Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_getFloatValue([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, float \*value) - Get the float value from a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[out]** The retrieved float value. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle - QAIRT\_OPCONFIG\_ERROR\_INVALID\_ARGUMENT: *value* is NULL or scalar is not float type Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_getDoubleValue([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, double \*value) - Get the double value from a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[out]** The retrieved double value. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle - QAIRT\_OPCONFIG\_ERROR\_INVALID\_ARGUMENT: *value* is NULL or scalar is not double type Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_getUint64Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, uint64\_t \*value) - Get the uint64 value from a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[out]** The retrieved uint64 value. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle - QAIRT\_OPCONFIG\_ERROR\_INVALID\_ARGUMENT: *value* is NULL or scalar is not uint64 type Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_getUint32Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, uint32\_t \*value) - Get the uint32 value from a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[out]** The retrieved uint32 value. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle - QAIRT\_OPCONFIG\_ERROR\_INVALID\_ARGUMENT: *value* is NULL or scalar is not uint32 type Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_getUint16Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, uint16\_t \*value) - Get the uint16 value from a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[out]** The retrieved uint16 value. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle - QAIRT\_OPCONFIG\_ERROR\_INVALID\_ARGUMENT: *value* is NULL or scalar is not uint16 type Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_getUint8Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, uint8\_t \*value) - Get the uint8 value from a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[out]** The retrieved uint8 value. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle - QAIRT\_OPCONFIG\_ERROR\_INVALID\_ARGUMENT: *value* is NULL or scalar is not uint8 type Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_getInt64Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, int64\_t \*value) - Get the int64 value from a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[out]** The retrieved int64 value. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle - QAIRT\_OPCONFIG\_ERROR\_INVALID\_ARGUMENT: *value* is NULL or scalar is not int64 type Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_getInt32Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, int32\_t \*value) - Get the int32 value from a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[out]** The retrieved int32 value. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle - QAIRT\_OPCONFIG\_ERROR\_INVALID\_ARGUMENT: *value* is NULL or scalar is not int32 type Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_getInt16Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, int16\_t \*value) - Get the int16 value from a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[out]** The retrieved int16 value. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle - QAIRT\_OPCONFIG\_ERROR\_INVALID\_ARGUMENT: *value* is NULL or scalar is not int16 type Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_getInt8Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, int8\_t \*value) - Get the int8 value from a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[out]** The retrieved int8 value. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle - QAIRT\_OPCONFIG\_ERROR\_INVALID\_ARGUMENT: *value* is NULL or scalar is not int8 type Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_getStringValue([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, const char \*\*value) - Get the string value from a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[out]** The retrieved string value. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle - QAIRT\_OPCONFIG\_ERROR\_INVALID\_ARGUMENT: *value* is NULL or scalar is not string type Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_getBoolValue([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, uint8\_t \*value) - Get the boolean value from a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[out]** The retrieved boolean value. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle - QAIRT\_OPCONFIG\_ERROR\_INVALID\_ARGUMENT: *value* is NULL or scalar is not boolean type Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_setFloatValue([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, const float value) - Set the float value of a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[in]** The float value to set. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_setDoubleValue([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, const double value) - Set the double value of a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[in]** The double value to set. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_setUint64Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, const uint64\_t value) - Set the uint64 value of a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[in]** The uint64 value to set. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_setUint32Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, const uint32\_t value) - Set the uint32 value of a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[in]** The uint32 value to set. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_setUint16Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, const uint16\_t value) - Set the uint16 value of a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[in]** The uint16 value to set. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_setUint8Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, const uint8\_t value) - Set the uint8 value of a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[in]** The uint8 value to set. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_setInt64Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, const int64\_t value) - Set the int64 value of a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[in]** The int64 value to set. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_setInt32Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, const int32\_t value) - Set the int32 value of a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[in]** The int32 value to set. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_setInt16Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, const int16\_t value) - Set the int16 value of a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[in]** The int16 value to set. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_setInt8Value([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, const int8\_t value) - Set the int8 value of a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[in]** The int8 value to set. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_setStringValue([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, const char \*value) - Set the string value of a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[in]** The string value to set. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle - QAIRT\_OPCONFIG\_ERROR\_INVALID\_ARGUMENT: *value* is NULL - QAIRT\_OPCONFIG\_ERROR\_MEM\_ALLOC: Memory allocation error while setting string value Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). - [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) QairtScalar\_setBoolValue([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t) scalarHandle, const uint8\_t value) - Set the boolean value of a scalar. - Parameters - - **scalarHandle** – **[in]** A handle to the scalar. - **value** – **[in]** The boolean value to set. - Returns - Error code: - QAIRT\_SUCCESS: No error encountered - QAIRT\_OPCONFIG\_ERROR\_INVALID\_HANDLE: *scalarHandle* is not a valid handle Note Use corresponding API through [QairtScalar\_V1\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#structQairtScalar__V1__t). Typedefs - typedef struct \_QairtScalar\_Handle\_t \*QairtScalar\_Handle\_t - Scalar handle used to interface with Scalar APIs. The handle itself is created and freed by the client. Copy to clipboard - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_CreateFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t)\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_FreeFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t)) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_GetDataTypeFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), [Qairt\_DataType\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv416Qairt_DataType_t)\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_GetFloatValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), float\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_GetDoubleValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), double\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_GetUint64ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), uint64\_t\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_GetUint32ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), uint32\_t\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_GetUint16ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), uint16\_t\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_GetUint8ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), uint8\_t\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_GetInt64ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), int64\_t\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_GetInt32ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), int32\_t\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_GetInt16ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), int16\_t\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_GetInt8ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), int8\_t\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_GetStringValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), const char\*\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_GetBoolValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), uint8\_t\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_SetFloatValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), const float) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_SetDoubleValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), const double) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_SetUint64ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), const uint64\_t) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_SetUint32ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), const uint32\_t) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_SetUint16ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), const uint16\_t) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_SetUint8ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), const uint8\_t) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_SetInt64ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), const int64\_t) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_SetInt32ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), const int32\_t) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_SetInt16ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), const int16\_t) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_SetInt8ValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), const int8\_t) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_SetStringValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), const char\*) - - typedef [Qairt\_Status\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv414Qairt_Status_t) (\*QairtScalar\_SetBoolValueFn\_t)([QairtScalar\_Handle\_t](https://docs.qualcomm.com/doc/80-63442-10/topic/QairtCommon.html#_CPPv420QairtScalar_Handle_t), const uint8\_t) - Last Published: Aug 06, 2026 [Previous Topic QairtQuantizeParams](https://docs.qualcomm.com/bundle/publicresource/80-63442-10/topics/QairtQuantizeParams.md) [Next Topic C++ API](https://docs.qualcomm.com/bundle/publicresource/80-63442-10/topics/index_cpp-api.md)