Multiplatform SDK Object Initialization

Before beginning any operation, you must first create an instance of the RUISDK object. The constructor is defined below. RUISDK creates an instance of the SDK. The constructor does not configure the SDK (RUISDK.CreateConfig) nor start the SDK (RUISDK.StartSDK).

A typical client will create only a single instance of the SDK. Creating more than one SDK instance is allowed and is used to support clients that are plug-ins or other scenarios whereby multiple independent clients may co-exist in the same executable. Multiple SDK instances perform independently of one another with the potential exception of shared or unshared configuration file (RUISDK.CreateConfig).

RUISDK

RUISDK (Boolean registerDefaultGraphicalReachOutHandler, String sdkDLLPath, String sdkDLLName)¶

Parameters

RUISDK has the following parameters:

RUISDK Parameters

Parameter	Description
registerDefaultGraphicalReachOutHandler()	If set to true, automatically registers the default graphical ReachOut. If false, no default ReachOut is registered.
sdkDLLPath (String)	Path to the core SDK DLL.
sdkDLLName (String)	DLL name is required and it has to be sent as a parameter. For example: Windows ruiSDK_5.6.0.x64.dll macOS librui_5.6.1.x64.dylib"/"librui_5.6.1.arm.dylib Linux librui_5.6.0.x64.so Note the following: • The .dll, .dylib, or .so file mentioned in sdkDLLName should explicitly be present in the path mentioned for sdkDLLPath. • The path given in sdkDLLPath should be the client machine where the file will be executed.

Throws

RUISDK throws a RUISDKCreationException If there is a problem constructing the SDK instance; this is the only SDK method that throws an exception.