Setting Product Language
The ruiSetProductLanguage() function allows you to set the language that the client is viewing your product. This is useful for products that have been internationalized, so you can determine how many installations are running your software in a particular language.
Note:This is different than the OS language that is collected automatically by the Usage Intelligence SDK.
RUIRESULT ruiSetProductLanguage(RUIINSTANCE* ruiInstance, const char* productLanguage)
Parameters
The ruiSetProductLanguage() function has the following parameters.
|
Parameter |
Description |
|
ruiInstance (RUIINSTANCE*) |
Pointer to the Usage Intelligence instance created via ruiCreateInstance(). |
|
productLanguage (const char*) |
The product language that is to be set. Maximum length of 128 characters. Note:A NULL value removes any previous value. |
Returns
The ruiSetProductLanguage() 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. |