Scanbot SDK
Loading...
Searching...
No Matches
ScanbotSDK.h File Reference

The Scanbot SDK C API. More...

Go to the source code of this file.

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.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_set_logging (bool enable)
 Enable or disable logging.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_set_log_handler (void(*log_handler)(const char *message))
 Sets the log handler.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_reset_log_handler ()
 Resets any previously set log handler.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_log_error (const char *message)
 Logs an error message using the Scanbot SDK logger.
 

Detailed Description

The Scanbot SDK C API.