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

ScanbotSDK Error Code C API. More...

Go to the source code of this file.

Typedefs

typedef enum scanbotsdk_error_code_t scanbotsdk_error_code_t
 The error codes returned by most of the Scanbot SDK functions.
 

Enumerations

enum  scanbotsdk_error_code_t {
  SCANBOTSDK_OK = 0 ,
  SCANBOTSDK_ERROR_UNKNOWN_ERROR ,
  SCANBOTSDK_ERROR_INVALID_LICENSE_STATUS ,
  SCANBOTSDK_ERROR_NULL_POINTER ,
  SCANBOTSDK_ERROR_INVALID_ARGUMENT ,
  SCANBOTSDK_ERROR_INVALID_IMAGE_REF ,
  SCANBOTSDK_ERROR_COMPONENT_UNAVAILABLE ,
  SCANBOTSDK_ERROR_ILLEGAL_STATE ,
  SCANBOTSDK_ERROR_IO_ERROR ,
  SCANBOTSDK_ERROR_INVALID_DATA ,
  SCANBOTSDK_ERROR_OPERATION_CANCELED ,
  SCANBOTSDK_ERROR_OUT_OF_MEMORY ,
  SCANBOTSDK_ERROR_TIMEOUT
}
 The error codes returned by most of the Scanbot SDK functions. More...
 

Functions

const char * scanbotsdk_error_message ()
 Error message for the last error code returned by the Scanbot SDK functions.
 

Detailed Description

ScanbotSDK Error Code C API.

Enumeration Type Documentation

◆ scanbotsdk_error_code_t

The error codes returned by most of the Scanbot SDK functions.

Enumerator
SCANBOTSDK_OK 

No error

SCANBOTSDK_ERROR_UNKNOWN_ERROR 

An unknown error has occurred

SCANBOTSDK_ERROR_INVALID_LICENSE_STATUS 

There is no installed license, the license is invalid, no longer valid or does not cover the current OS or operation. Check the license status for more details by calling scanbotsdk_get_license_status.

SCANBOTSDK_ERROR_NULL_POINTER 

A null pointer was passed to a function

SCANBOTSDK_ERROR_INVALID_ARGUMENT 

An invalid argument was passed to a function

SCANBOTSDK_ERROR_INVALID_IMAGE_REF 

Image operation such as save or encode failed

SCANBOTSDK_ERROR_COMPONENT_UNAVAILABLE 

Scanbot SDK component needed for the operation is not available

SCANBOTSDK_ERROR_ILLEGAL_STATE 

The operation is not allowed in the current state

SCANBOTSDK_ERROR_IO_ERROR 

Input/output error

SCANBOTSDK_ERROR_INVALID_DATA 

The data to be processed is invalid

SCANBOTSDK_ERROR_OPERATION_CANCELED 

The operation was canceled

SCANBOTSDK_ERROR_OUT_OF_MEMORY 

The operation ran out of memory

SCANBOTSDK_ERROR_TIMEOUT 

The operation timed out