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

Go to the source code of this file.

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.