Creating the Usage Intelligence SDK Instance

The ruiCreateInstance() function creates the Usage Intelligence SDK instance to be used by the application. All subsequent Usage Intelligence SDK calls use the created instance as a parameter. This function also allocates the internal resources for the Usage Intelligence SDK instance. Calls to ruiCreateConfig() and ruiStartSDK() follow the creation of this object.

ruiCreateInstance()

RUIINSTANCE* ruiCreateInstance(bool registerDefaultGraphicalReachOutHandler)

Parameters

The ruiCreateInstance() function has the following parameters:

ruiCreateInstance() Parameters

Parameter

Description

registerDefaultGraphicalReachOutHandler

(Boolean) On platforms that contain an SDK default graphical ReachOut handler (Windows and macOS), automatically register that handler via ruiSetReachOutHandler().

Returns

The opaque handle to the SDK instance, that is used in other API calls. NULL is returned if there is a creation error.