Typedefs
typedef enum scanbotsdk_license_status_t	scanbotsdk_license_status_t
	scanbotsdk_license_status_t enum

typedef struct scanbotsdk_device_deregistration_error_t	scanbotsdk_device_deregistration_error_t
	scanbotsdk_device_deregistration_error_t class

typedef struct scanbotsdk_license_info_t	scanbotsdk_license_info_t
	scanbotsdk_license_info_t class

typedef enum scanbotsdk_feature_t	scanbotsdk_feature_t
	scanbotsdk_feature_t enum

Enumerations
enum	scanbotsdk_license_status_t { SCANBOTSDK_LICENSE_STATUS_OKAY = 0 , SCANBOTSDK_LICENSE_STATUS_TRIAL = 1 , SCANBOTSDK_LICENSE_STATUS_OKAY_EXPIRING_SOON = 2 , SCANBOTSDK_LICENSE_STATUS_FAILURE_NOT_SET = 10 , SCANBOTSDK_LICENSE_STATUS_FAILURE_CORRUPTED = 11 , SCANBOTSDK_LICENSE_STATUS_FAILURE_WRONG_OS = 12 , SCANBOTSDK_LICENSE_STATUS_FAILURE_APP_ID_MISMATCH = 13 , SCANBOTSDK_LICENSE_STATUS_FAILURE_EXPIRED = 14 , SCANBOTSDK_LICENSE_STATUS_FAILURE_SERVER = 15 , SCANBOTSDK_LICENSE_STATUS_FAILURE_VERSION = 16 , SCANBOTSDK_LICENSE_STATUS_FAILURE_INACTIVE = 17 }
	scanbotsdk_license_status_t enum More...

enum	scanbotsdk_feature_t { SCANBOTSDK_FEATURE_BARCODE_SCANNER = 0 , SCANBOTSDK_FEATURE_CHECK_SCANNER = 1 , SCANBOTSDK_FEATURE_CREDIT_CARD_SCANNER = 2 , SCANBOTSDK_FEATURE_IMAGE_PROCESSING = 3 , SCANBOTSDK_FEATURE_DOCUMENT_SCANNER = 4 , SCANBOTSDK_FEATURE_LICENSE_PLATE_SCANNER = 5 , SCANBOTSDK_FEATURE_MEDICAL_CERTIFICATE_SCANNER = 6 , SCANBOTSDK_FEATURE_MRZ_SCANNER = 7 , SCANBOTSDK_FEATURE_OCR = 8 , SCANBOTSDK_FEATURE_TEXT_PATTERN_SCANNER = 9 , SCANBOTSDK_FEATURE_PDF_CREATION = 10 , SCANBOTSDK_FEATURE_ID_CARD_SCANNER = 11 , SCANBOTSDK_FEATURE_DRIVER_LICENSE_SCANNER = 12 , SCANBOTSDK_FEATURE_EHIC_SCANNER = 13 , SCANBOTSDK_FEATURE_DOCUMENT_CLASSIFICATION = 14 }
	scanbotsdk_feature_t enum More...

Functions
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_license_status_t_to_string (scanbotsdk_license_status_t value, const char **result)
	Returns the string representation of the given scanbotsdk_license_status_t value.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_device_deregistration_error_create (int device_id, const char error_message, scanbotsdk_device_deregistration_error_t *result)
	Creates a new instance of scanbotsdk_device_deregistration_error with given params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_device_deregistration_error_free (scanbotsdk_device_deregistration_error_t *object)
	Frees the memory allocated for the instance of scanbotsdk_device_deregistration_error_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_device_deregistration_error_get_device_id (scanbotsdk_device_deregistration_error_t self, int device_id)
	Returns value of device_id field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_device_deregistration_error_get_error_message (scanbotsdk_device_deregistration_error_t self, const char *error_message)
	Returns value of error_message field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_license_info_free (scanbotsdk_license_info_t *object)
	Frees the memory allocated for the instance of scanbotsdk_license_info_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_license_info_get_status (scanbotsdk_license_info_t self, scanbotsdk_license_status_t status)
	Returns value of status field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_license_info_get_is_valid (scanbotsdk_license_info_t self, bool is_valid)
	Returns value of is_valid field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_license_info_get_license_status_message (scanbotsdk_license_info_t self, const char *license_status_message)
	Returns value of license_status_message field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_license_info_get_expiration_timestamp (scanbotsdk_license_info_t self, double expiration_timestamp)
	Returns value of expiration_timestamp field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_license_info_get_expiration_date_string (scanbotsdk_license_info_t self, const char *expiration_date_string)
	Returns value of expiration_date_string field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_license_info_get_error_message (scanbotsdk_license_info_t self, const char *error_message)
	Returns value of error_message field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_license_info_get_online_license_check_in_progress (scanbotsdk_license_info_t self, bool online_license_check_in_progress)
	Returns value of online_license_check_in_progress field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_license_info_get_license (scanbotsdk_license_info_t self, const char *license)
	Returns value of license field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_license_info_get_devices (scanbotsdk_license_info_t self, int *devices)
	Returns value of devices field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_license_info_get_next_online_license_check_in_ms (scanbotsdk_license_info_t self, double next_online_license_check_in_ms)
	Returns value of next_online_license_check_in_ms field of the given object.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_license_info_get_device_deregistation_errors (scanbotsdk_license_info_t self, scanbotsdk_device_deregistration_error_t *device_deregistation_errors, size_t size)
	Returns value of device_deregistation_errors field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_license_info_get_device_deregistation_errors_size (scanbotsdk_license_info_t self, size_t size)
	Returns size of device_deregistation_errors array.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_feature_t_to_string (scanbotsdk_feature_t value, const char **result)
	Returns the string representation of the given scanbotsdk_feature_t value.

Detailed Description

Typedef Documentation

◆ scanbotsdk_device_deregistration_error_t

typedef struct scanbotsdk_device_deregistration_error_t scanbotsdk_device_deregistration_error_t

scanbotsdk_device_deregistration_error_t class

Description of error that occurred during device deregistration.

◆ scanbotsdk_feature_t

typedef enum scanbotsdk_feature_t scanbotsdk_feature_t

scanbotsdk_feature_t enum

License features.

◆ scanbotsdk_license_info_t

typedef struct scanbotsdk_license_info_t scanbotsdk_license_info_t

scanbotsdk_license_info_t class

Information about the SDK license.

◆ scanbotsdk_license_status_t

typedef enum scanbotsdk_license_status_t scanbotsdk_license_status_t

scanbotsdk_license_status_t enum

Status of the license plate scanner.

Enumeration Type Documentation

◆ scanbotsdk_feature_t

enum scanbotsdk_feature_t

scanbotsdk_feature_t enum

License features.

Enumerator
SCANBOTSDK_FEATURE_BARCODE_SCANNER	Barcode scanner.
SCANBOTSDK_FEATURE_CHECK_SCANNER	Check scanner.
SCANBOTSDK_FEATURE_CREDIT_CARD_SCANNER	Credit card scanner.
SCANBOTSDK_FEATURE_IMAGE_PROCESSING	Image processing.
SCANBOTSDK_FEATURE_DOCUMENT_SCANNER	Document scanner.
SCANBOTSDK_FEATURE_LICENSE_PLATE_SCANNER	License plate scanner.
SCANBOTSDK_FEATURE_MEDICAL_CERTIFICATE_SCANNER	Medical certificate scanner.
SCANBOTSDK_FEATURE_MRZ_SCANNER	MRZ scanner.
SCANBOTSDK_FEATURE_OCR	OCR.
SCANBOTSDK_FEATURE_TEXT_PATTERN_SCANNER	Text pattern scanner.
SCANBOTSDK_FEATURE_PDF_CREATION	PDF creation.
SCANBOTSDK_FEATURE_ID_CARD_SCANNER	ID card scanner.
SCANBOTSDK_FEATURE_DRIVER_LICENSE_SCANNER	Driver license scanner.
SCANBOTSDK_FEATURE_EHIC_SCANNER	EHIC scanner.
SCANBOTSDK_FEATURE_DOCUMENT_CLASSIFICATION	Document classification.

◆ scanbotsdk_license_status_t

enum scanbotsdk_license_status_t

scanbotsdk_license_status_t enum

Status of the license plate scanner.

Enumerator
SCANBOTSDK_LICENSE_STATUS_OKAY	License is valid and accepted.
SCANBOTSDK_LICENSE_STATUS_TRIAL	No license set yet. The SDK is in trial mode.
SCANBOTSDK_LICENSE_STATUS_OKAY_EXPIRING_SOON	License is valid but will expire soon. Make sure to update your license before it expires to ensure uninterrupted function.
SCANBOTSDK_LICENSE_STATUS_FAILURE_NOT_SET	No license set. On platforms that support trial mode, it means that the SDK's trial mode is over.
SCANBOTSDK_LICENSE_STATUS_FAILURE_CORRUPTED	No license active. The set license was unreadable or has an invalid format.
SCANBOTSDK_LICENSE_STATUS_FAILURE_WRONG_OS	No license active. The set license does not cover the current operating system.
SCANBOTSDK_LICENSE_STATUS_FAILURE_APP_ID_MISMATCH	No license active. The set license does not cover the current app's bundle identifier.
SCANBOTSDK_LICENSE_STATUS_FAILURE_EXPIRED	No license active. The set license is valid but it has expired.
SCANBOTSDK_LICENSE_STATUS_FAILURE_SERVER	No license active. The online license check failed.
SCANBOTSDK_LICENSE_STATUS_FAILURE_VERSION	No license active. The set license does not cover the current SDK version.
SCANBOTSDK_LICENSE_STATUS_FAILURE_INACTIVE	No license active. The set license is not yet active.

Function Documentation

◆ scanbotsdk_device_deregistration_error_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_device_deregistration_error_create	(	int	device_id,
		const char *	error_message,
		scanbotsdk_device_deregistration_error_t **	result )

Creates a new instance of scanbotsdk_device_deregistration_error with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

device_id	Sequential number of the device registration. Starts with 0. Each time a call to initializeLicense with a new license is made, the device ID.
error_message	Error message describing the error. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_device_deregistration_error_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_device_deregistration_error_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_device_deregistration_error_free ( scanbotsdk_device_deregistration_error_t * object )

Frees the memory allocated for the instance of scanbotsdk_device_deregistration_error_t. If null is passed, the function does nothing.

Parameters

object Pointer to the instance of scanbotsdk_device_deregistration_error_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_device_deregistration_error_get_device_id()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_device_deregistration_error_get_device_id	(	scanbotsdk_device_deregistration_error_t *	self,
		int *	device_id )

Returns value of device_id field of the given object.

Sequential number of the device registration. Starts with 0. Each time a call to initializeLicense with a new license is made, the device ID.

Parameters

self	Pointer to the instance of scanbotsdk_device_deregistration_error_t
device_id	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_device_deregistration_error_get_error_message()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_device_deregistration_error_get_error_message	(	scanbotsdk_device_deregistration_error_t *	self,
		const char **	error_message )

Returns value of error_message field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Error message describing the error.

Parameters

self	Pointer to the instance of scanbotsdk_device_deregistration_error_t
error_message	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_feature_t_to_string()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_feature_t_to_string	(	scanbotsdk_feature_t	value,
		const char **	result )

Returns the string representation of the given scanbotsdk_feature_t value.

The returned string doesn't need to be freed.

Parameters

value	The value to be converted to string.
result	Pointer to a variable that will store the string representation of the value.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_license_info_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_license_info_free ( scanbotsdk_license_info_t * object )

Frees the memory allocated for the instance of scanbotsdk_license_info_t. If null is passed, the function does nothing.

Parameters

object Pointer to the instance of scanbotsdk_license_info_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_license_info_get_device_deregistation_errors()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_license_info_get_device_deregistation_errors	(	scanbotsdk_license_info_t *	self,
		scanbotsdk_device_deregistration_error_t **	device_deregistation_errors,
		size_t	size )

Returns value of device_deregistation_errors field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

List of errors that occurred during device deregistration. If for some device deregistration completed successfully, it will not be listed here. For each device at most one entry will be present.

Parameters

self	Pointer to the instance of scanbotsdk_license_info_t
size	Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function.
device_deregistation_errors	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_license_info_get_device_deregistation_errors_size()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_license_info_get_device_deregistation_errors_size	(	scanbotsdk_license_info_t *	self,
		size_t *	size )

Returns size of device_deregistation_errors array.

Parameters

self	Pointer to the instance of scanbotsdk_license_info_t
size	Pointer to a variable that will store the size.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_license_info_get_devices()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_license_info_get_devices	(	scanbotsdk_license_info_t *	self,
		int **	devices )

Returns value of devices field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Number of devices the license is valid for, if the license is floating.

Parameters

self	Pointer to the instance of scanbotsdk_license_info_t
devices	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_license_info_get_error_message()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_license_info_get_error_message	(	scanbotsdk_license_info_t *	self,
		const char **	error_message )

Returns value of error_message field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Additional error message in case of a license error.

Parameters

self	Pointer to the instance of scanbotsdk_license_info_t
error_message	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_license_info_get_expiration_date_string()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_license_info_get_expiration_date_string	(	scanbotsdk_license_info_t *	self,
		const char **	expiration_date_string )

Returns value of expiration_date_string field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Expiration date of the license or trial period in ISO 8601 date-time format.

Parameters

self	Pointer to the instance of scanbotsdk_license_info_t
expiration_date_string	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_license_info_get_expiration_timestamp()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_license_info_get_expiration_timestamp	(	scanbotsdk_license_info_t *	self,
		double *	expiration_timestamp )

Returns value of expiration_timestamp field of the given object.

Expiration timestamp of the license or trial period in seconds since the UNIX epoch.

Parameters

self	Pointer to the instance of scanbotsdk_license_info_t
expiration_timestamp	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_license_info_get_is_valid()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_license_info_get_is_valid	(	scanbotsdk_license_info_t *	self,
		bool *	is_valid )

Returns value of is_valid field of the given object.

True if the license status corresponds to a valid license.

Parameters

self	Pointer to the instance of scanbotsdk_license_info_t
is_valid	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_license_info_get_license()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_license_info_get_license	(	scanbotsdk_license_info_t *	self,
		const char **	license )

Returns value of license field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

The currently active license. May be different from the license used to initialize the SDK if the online license check has completed and the server has sent an updated license.

Parameters

self	Pointer to the instance of scanbotsdk_license_info_t
license	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_license_info_get_license_status_message()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_license_info_get_license_status_message	(	scanbotsdk_license_info_t *	self,
		const char **	license_status_message )

Returns value of license_status_message field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Message describing the license status.

Parameters

self	Pointer to the instance of scanbotsdk_license_info_t
license_status_message	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_license_info_get_next_online_license_check_in_ms()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_license_info_get_next_online_license_check_in_ms	(	scanbotsdk_license_info_t *	self,
		double *	next_online_license_check_in_ms )

Returns value of next_online_license_check_in_ms field of the given object.

Time in milliseconds until the next online license check will be performed. -1 if no online license check is scheduled.

Parameters

self	Pointer to the instance of scanbotsdk_license_info_t
next_online_license_check_in_ms	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_license_info_get_online_license_check_in_progress()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_license_info_get_online_license_check_in_progress	(	scanbotsdk_license_info_t *	self,
		bool *	online_license_check_in_progress )

Returns value of online_license_check_in_progress field of the given object.

True if an online license check is in progress.

Parameters

self	Pointer to the instance of scanbotsdk_license_info_t
online_license_check_in_progress	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_license_info_get_status()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_license_info_get_status	(	scanbotsdk_license_info_t *	self,
		scanbotsdk_license_status_t *	status )

Returns value of status field of the given object.

License status.

Parameters

self	Pointer to the instance of scanbotsdk_license_info_t
status	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_license_status_t_to_string()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_license_status_t_to_string	(	scanbotsdk_license_status_t	value,
		const char **	result )

Returns the string representation of the given scanbotsdk_license_status_t value.

The returned string doesn't need to be freed.

Parameters

value	The value to be converted to string.
result	Pointer to a variable that will store the string representation of the value.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ scanbotsdk_device_deregistration_error_t

◆ scanbotsdk_feature_t

◆ scanbotsdk_license_info_t

◆ scanbotsdk_license_status_t

Enumeration Type Documentation

◆ scanbotsdk_feature_t

◆ scanbotsdk_license_status_t

Function Documentation

◆ scanbotsdk_device_deregistration_error_create()

◆ scanbotsdk_device_deregistration_error_free()

◆ scanbotsdk_device_deregistration_error_get_device_id()

◆ scanbotsdk_device_deregistration_error_get_error_message()

◆ scanbotsdk_feature_t_to_string()

◆ scanbotsdk_license_info_free()

◆ scanbotsdk_license_info_get_device_deregistation_errors()

◆ scanbotsdk_license_info_get_device_deregistation_errors_size()

◆ scanbotsdk_license_info_get_devices()

◆ scanbotsdk_license_info_get_error_message()

◆ scanbotsdk_license_info_get_expiration_date_string()

◆ scanbotsdk_license_info_get_expiration_timestamp()

◆ scanbotsdk_license_info_get_is_valid()

◆ scanbotsdk_license_info_get_license()

◆ scanbotsdk_license_info_get_license_status_message()

◆ scanbotsdk_license_info_get_next_online_license_check_in_ms()

◆ scanbotsdk_license_info_get_online_license_check_in_progress()

◆ scanbotsdk_license_info_get_status()

◆ scanbotsdk_license_status_t_to_string()