Getting SDK Version Information
ruiGetSDKVersion() will always allocate memory (regardless of return code), and the client application is responsible for freeing that memory via ruiFree() when the memory is no longer needed.
ruiGetSDKVersion() can be called between ruiCreateInstance() and ruiDestroyInstance(), and can be called more than once.
ruiGetSDKVersion() is a synchronous function, returning when all functionality is completed.
RUIRESULT ruiGetSDKVersion(RUIINSTANCE* ruiInstance, char** sdkVersion)
Parameters
The ruiGetSDKVersion() function has the following parameters.
|
Parameter |
Description |
|
ruiInstance (RUIINSTANCE*) |
Pointer to the Usage Intelligence instance created via ruiCreateInstance(). |
|
sdkVersion (char**) |
Receives the version string allocated by the SDK; must be freed via ruiFree(). |
Returns
The ruiGetSDKVersion() 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_INVALID_PARAMETER_EXPECTED_NON_NULL |
Some API parameter is expected to be non-NULL, and is not. |