Setting Product Data
The ruiSetProductData() function sets or clears the product data.
Note:The product data must be set every time the SDK instance is run.
Note:This is different than V4 of the Usage Intelligence (Trackerbird) SDK where the supplied product data was stored in the SDK configuration file and if it was not supplied, the values in the configuration file were used.
ruiSetProductData() can be called between ruiCreateConfig() and ruiStopSDK() and can be called zero or more times.
ruiSetProductData() is a synchronous function returning when all functionality is completed.
RUIRESULT ruiSetProductData(RUIINSTANCE* ruiInstance, const char* productEdition, const char* productLanguage, const char* productVersion, const char* productBuildNumber)
Parameters
The ruiSetProductData() function has the following parameters.
|
Parameter |
Description |
|
ruiInstance (RUIINSTANCE*) |
Pointer to the Usage Intelligence instance created via ruiCreateInstance(). |
|
productEdition (const char*) |
The product edition that is to be set. Maximum length of 128 characters. Note:A NULL value removes any previous value |
|
productLanguage (const char*) |
The product language that is to be set. Maximum length of 128 characters. Note:A NULL value removes any previous value |
|
productVersion (const char*) |
The product version that is to be set. Maximum length of 128 characters. Note:A NULL value removes any previous value |
|
productBuildNumber (const char*) |
The product build number that is to be set. Maximum length of 128 characters. Note:A NULL value removes any previous value |
Returns
The ruiSetProductData() function returns one of the return status constants below.
|
Return |
Description |
|
RUI_OK |
Function successful. |
|
RUI_INVALID_SDK_OBJECT |
SDK Instance parameter is NULL or invalid. |
|
RUI_SDK_INTERNAL_ERROR_FATAL |
Irrecoverable internal fatal error. No further API calls should be made. |
|
RUI_SDK_ABORTED |
A required New Registration has failed, and hence the SDK is aborted. ruiStopSDK() and ruiDestroyInstance() are possible. |
|
RUI_SDK_SUSPENDED |
The Server has instructed a temporary back-off. |
|
RUI_SDK_PERMANENTLY_DISABLED |
The Server has instructed a permanent disable. |
|
RUI_SDK_OPTED_OUT |
Instance has been instructed by the application to opt-out. |
|
RUI_CONFIG_NOT_CREATED |
Configuration has not been successfully created. |
|
RUI_SDK_ALREADY_STOPPED |
SDK has already been successfully stopped. |