Scanbot SDK
Loading...
Searching...
No Matches
Typedefs | Enumerations | Functions
Scanbot C SDK Initialization and License Management

Typedefs

typedef enum scanbotsdk_license_status_t scanbotsdk_license_status_t
 The status of the license.
 

Enumerations

enum  scanbotsdk_license_status_t {
  SCANBOTSDK_LICENSE_STATUS_OK = 0 ,
  SCANBOTSDK_LICENSE_STATUS_FAILURE_CORRUPTED ,
  SCANBOTSDK_LICENSE_STATUS_FAILURE_WRONG_OS ,
  SCANBOTSDK_LICENSE_STATUS_FAILURE_APP_ID_MISMATCH ,
  SCANBOTSDK_LICENSE_STATUS_FAILURE_EXPIRED ,
  SCANBOTSDK_LICENSE_STATUS_FAILURE_UNKNOWN
}
 The status of the license. More...
 

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_get_license_status (scanbotsdk_license_status_t *status)
 Returns the current license status.
 

Detailed Description

Enumeration Type Documentation

◆ scanbotsdk_license_status_t

The status of the license.

Enumerator
SCANBOTSDK_LICENSE_STATUS_OK 

License is valid.

SCANBOTSDK_LICENSE_STATUS_FAILURE_CORRUPTED 

License is invalid, likely due to a corruption.

SCANBOTSDK_LICENSE_STATUS_FAILURE_WRONG_OS 

License is valid, but does not cover the current OS.

SCANBOTSDK_LICENSE_STATUS_FAILURE_APP_ID_MISMATCH 

License is valid, but does not cover the current application.

SCANBOTSDK_LICENSE_STATUS_FAILURE_EXPIRED 

License is valid but has expired.

SCANBOTSDK_LICENSE_STATUS_FAILURE_UNKNOWN 

License verification failed.

Function Documentation

◆ scanbotsdk_get_license_status()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_get_license_status ( scanbotsdk_license_status_t status)

Returns the current license status.

Parameters
statusPointer to a variable that will be set to the current license status.
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
license_keyThe license key. Must be a null terminated string.
Returns
: Error code, SCANBOTSDK_OK if license initialization was successful