Scanbot C SDK Initialization and License Management

Topics
	Scanbot C SDK Logger

Classes
struct	scanbotsdk_init_params_t
	Initialization parameters for the Scanbot SDK. More...

Typedefs
typedef struct scanbotsdk_init_params_t	scanbotsdk_init_params_t
	Initialization parameters for the Scanbot SDK.

Functions
SBSDK_API const char *	scanbotsdk_get_git_version ()
	Returns the git version of the Scanbot SDK as a null-terminated string.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_initialize (const scanbotsdk_init_params_t *init_params)
	Initialize the Scanbot SDK. You must always call this function before using any other Scanbot SDK functions.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_deregister_device ()
	Effectively notifies the server that the license is no longer used by this device.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_wait_for_device_deregistration_completion (int timeout_ms)
	Wait for the completion of the all device deregistration processes. See scanbotsdk_deregister_device for more information.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_get_license_info (scanbotsdk_license_info_t **info)
	Returns the current license information.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_wait_for_online_license_check_completion (int timeout_ms)
	Wait for the completion of the online license check. Returns immediately if there's no online license check in progress.

Variables
const char *	license_key
	The license key. Must be a null terminated string.
const char *	writeable_path
	Path to which the SDK can write internal data.

Detailed Description

---

Class Documentation

scanbotsdk_init_params_t

struct scanbotsdk_init_params_t

Initialization parameters for the Scanbot SDK.

Public Attributes
const char *	license_key
	The license key. Must be a null terminated string.
const char *	writeable_path
	Path to which the SDK can write internal data.

Function Documentation

scanbotsdk_deregister_device()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_deregister_device

(

)

Effectively notifies the server that the license is no longer used by this device.

After calling the method SDK behaves like no license is available. You should call this method if you are using floating license to notify the server that the device is no longer using the license and so another device can use it. If you are using a floating license, but you do not call this method, the license will be released automatically after a period specified in the license. If during work with the SDK you initialize the SDK with multiple licenses, there is no need to call the function after finishing work with each of the licenses, only with the last one. For others, the function is implicitly called automatically. The function returns immediately, but the deregistration process may take some time.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_get_license_info()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_get_license_info

(

scanbotsdk_license_info_t **

info

)

Returns the current license information.

Parameters

info	Pointer to a variable that will be set to the current license information. The caller must call scanbotsdk_license_info_free() once the object is no longer needed.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_initialize()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_initialize

(

const scanbotsdk_init_params_t *

init_params

)

Initialize the Scanbot SDK. You must always call this function before using any other Scanbot SDK functions.

Parameters

init_params

The initialization parameters. You must provide a valid license key.

Returns

: Error code, SCANBOTSDK_OK if license initialization was successful

scanbotsdk_wait_for_device_deregistration_completion()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_wait_for_device_deregistration_completion

(

int

timeout_ms

)

Wait for the completion of the all device deregistration processes. See scanbotsdk_deregister_device for more information.

Parameters

timeout_ms

Timeout in milliseconds.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered. SCANBOTSDK_ERROR_TIMEOUT_ERROR if waiting times out.

scanbotsdk_wait_for_online_license_check_completion()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_wait_for_online_license_check_completion

(

int

timeout_ms

)

Wait for the completion of the online license check. Returns immediately if there's no online license check in progress.

Parameters

timeout_ms

Timeout in milliseconds.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered. SCANBOTSDK_ERROR_TIMEOUT_ERROR if waiting times out.