#import <Foundation/Foundation.h>

Classes
class	kfxError
	An error lookup reference class. More...

Macros
#define	KMC_GN_BASE 0x1000

#define	KMC_UI_BASE 0x2000

#define	KMC_LO_BASE 0x3000

#define	KMC_CD_BASE 0x4000

#define	KMC_IP_BASE 0x5000

#define	KMC_ED_BASE 0x6000

#define	KMC_UT_BASE 0x7000

#define	KMC_EX_BASE 0x8000

#define	KMC_BC_BASE 0xB000

#define	KMC_CL_BASE 0xC000

#define	KMC_EV_BASE 0xE000

#define	KMC_SUCCESS 0

#define	KFX_ERROR_DOMAIN @"com.kofax.mobilesdk"

Typedefs
typedef enum kfxErrorGeneral	KFX_ERROR_GENERAL
	General Errors enum. More...

typedef enum kfxKedErrorEngineData	KFX_ERROR_ENGINE_DATA
	Engine Data Errors enum. More...

typedef enum kfxErrorUIControls	KFX_ERROR_UICONTROLS_ERRORS
	UI Control Errors enum. More...

typedef enum kfxErrorLogistics	KFX_ERROR_LOGISTICS_ERRORS
	Logistics Errors enum. More...

typedef enum kfxErrorImageProcessor	KFX_ERROR_IMAGE_PROCESSOR
	Image Processor Errors enum. More...

typedef enum kfxErrorEv	KFX_ERROR_PERFECTION
	Image Perfection Errors enum. More...

typedef enum kfxClassifier	KFX_ERROR_CLASSIFIER

typedef enum kfxErrorUtilities	KFX_ERROR_UTILITIES
	Utilities Errors enum. More...

typedef enum kfxErrorBarcodeReader	KFX_ERROR_BARCODE_READER
	An enumeration containing the different error return types. More...

typedef enum kfxErrorExtraction	KFX_ERROR_EXTRACTION
	Extraction errors enum. More...

Enumerations
enum	kfxErrorGeneral { KGN_BASE = KMC_GN_BASE, KMC_GN_FILE_NOT_FOUND, KMC_GN_OUT_OF_MEMORY, KMC_GN_UNKNOWN_ERROR, KMC_GN_PARAM_NEGATIVE, KMC_GN_UNSUPPORTED_OPERATION, KMC_GN_LAST }
	General Errors enum. More...

enum	kfxKedErrorEngineData { KED_BASE = KMC_ED_BASE, KMC_ED_FILEPATH, KMC_ED_MIMETYPE, KMC_ED_NOIMAGE, KMC_ED_IMAGELEAK, KMC_ED_INVALID_COLOR, KMC_ED_NONEXISTENT_FILE, KMC_ED_FILE_NOT_DELETABLE, KMC_ED_FILE_STILL_REMAINS, KMC_ED_MISSING_FILE_EXTENSION, KMC_ED_MIMETYPE_MISMATCH, KMC_ED_JPEG_BITDEPTH, KMC_ED_FILE_EXISTS, KMC_ED_IMAGE_IS_SCALED, KMC_ED_OBJECT_REP_BITMAP_MISMATCH, KMC_ED_OBJECT_REP_FILE_MISMATCH, KMC_ED_ILLEGAL_STATE, KMC_ED_INVALID_ISO_DATE_TIME_FORMAT, KMC_ED_INVALID_JPEG_QUALITY_VALUE, KMC_ED_BITMAP_WRITE_TO_FILE_FAILED, KMC_ED_INVALID_DPI, KMC_ED_ALREADY_CLEAR, KMC_ED_ALTERNATE_FILEIO_ENGINE, KMC_ED_BITMAP_READ_FROM_FILE_FAILED, KMC_ED_PNG_FILE_WRITE, KMC_ED_NO_MEMORY_FOR_METADATA, KMC_ED_FILE_EXTENSION, KMC_ED_INVALID_ROTATION, KMC_ED_INVALID_BITDEPTH, KMC_ED_INVALID_TETRAGON_CORNERS, KMC_ED_IMAGE_COLOR_SPACE, KMC_ED_IMAGE_CONTEXT, KMC_ED_IMAGE_WRITTEN_IS_NOT_BITONAL, KMC_ED_IMAGE_WRITTEN_IS_NOT_GRAY, KMC_ED_INVALID_CROP, KMC_ED_IMAGE_INVALID, KMC_ED_UNRECOGNIZED_MIME_TYPE, KMC_ED_BITMAP_DIMENSIONS_IMMUTABLE, KMC_ED_BITMAP_DIMENSIONS_NO_UPSCALE, KMC_ED_IMAGE_FILE_DIMENSIONS_ERROR, KMC_ED_IMAGE_INVALID_SCALING_FACTOR, KMC_ED_IMAGE_PERFECTION_PROFILE_EMPTY, KMC_ED_OBJECT_REP_NO_BITMAP, KMC_ED_BUFFER_EXISTS, KMC_ED_BUFFER, KMC_ED_BUFFER_ALREADY_CLEARED, KMC_ED_OBJECT_REP_MISMATCH, KMC_ED_ALREADY_BUFFERED, KMC_ED_DELETE_BUFFERED_FILE, KMC_ED_NO_MEMORY_FOR_BUFFERED_FILE, KMC_ED_BUFFERED_READ_FAILED, KMC_ED_NO_BUFFERED_IMAGE, KMC_ED_INVALID_FOR_OBJECT_REP, KMC_ED_NONEXISTENT_LOAD_SETTINGS_FILE, KMC_ED_RESTRICTION_MIMETYPE_MISMATCH, KMC_ED_RESTRICTION_INVALID_COLOR, KMC_ED_RESTRICTION_INVALID_DPI, KMC_ED_INVALID_DOCUMENT_DIMENSIONS, KMC_ED_LAST }
	Engine Data Errors enum. More...

enum	kfxErrorUIControls { KMC_UI_UNKNOWN = KMC_UI_BASE, KMC_UI_FLASH_AUTO_NOT_SUPPORTED, KMC_UI_FLASH_ON_NOT_SUPPORTED, KMC_UI_FLASH_OFF_NOT_SUPPORTED, KMC_UI_SCALING_FACTOR, KMC_UI_INVALID_THRESHOLD_ARGUMENT, KMC_UI_INVALID_DECLINATION_ARGUMENT, KMC_UI_INVALID_STABILITY_DELAY_ARGUMENT, KMC_UI_IMAGE_NULL, KMC_UI_CAMERA_ALREADY_OPEN, KMC_UI_CAMERA_OPERATION_FAILURE, KMC_UI_CAMERA_LOCK_ACQUIRE_FAILURE, KMC_UI_INVALID_AXIS_THRESHOLD_ARGUMENT, KMC_UI_INVALID_PAGE_THRESHOLD_ARGUMENT, KMC_UI_FOCUS_AREA_NOT_SUPPORTED, KMC_UI_FOCUS_AREA_COUNT, KMC_UI_FOCUS_AREA_EMPTY, KMC_UI_FLASH_TORCH_NOT_SUPPORTED, KMC_UI_INVALID_PADDING_PERCENTAGE_ARGUMENT, KMC_UI_INVALID_ASPECT_RATIO_ARGUMENT, KMC_UI_INVALID_BORDER_THICKNESS_ARGUMENT, KMC_UI_INVALID_WIDTH_ARGUMENT, KMC_UI_INVALID_HEIGHT_ARGUMENT, KMC_UI_INVALID_LEVEL_THRESHOLD, KMC_UI_TORCH_UNAVAILABLE, KMC_UI_LAST }
	UI Control Errors enum. More...

enum	kfxErrorLogistics { KLO_BASE = KMC_LO_BASE, KMC_LO_INVALID_SERVER_URL, KMC_LO_SERVER_URL_NOT_SET, KMC_LO_USERNAME_NOT_SET, KMC_LO_USER_ALREADY_LOGGED_IN, KMC_LO_USER_NOT_LOGGED_IN_ON_LOGOUT, KMC_LO_USER_LOGGING_IN_ON_LOGIN, KMC_LO_USER_ALREADY_LOGGED_OUT, KMC_LO_USER_LOGGING_OUT_ON_LOGOUT, KMC_LO_DEVICE_REG_LICENSING_ERROR, KMC_LO_SESSION_STATE_BUSY, KMC_LO_USER_LOGIN_ERROR, KMC_LO_PAGE_NOT_FOUND, KMC_LO_IMAGE_NOT_FOUND, KMC_LO_DOMAIN, KMC_LO_EMAIL, KMC_LO_NOT_REGISTERED, KMC_LO_REGISTERING, KMC_LO_OVERLAPPED_OPERATIONS, KMC_LO_INVALID_SESSION_STATE, KMC_LO_LOGIN_NOT_ALLOWED, KMC_LO_NOT_LOGGED_IN, KMC_LO_USER_LOGOUT_ERROR, KMC_LO_TASK_LOCK_ACQUIRE_ERROR, KMC_LO_NO_OPERATION_TO_CANCEL, KMC_LO_OPERATION_NOT_CANCELLABLE, KMC_LO_OPERATION_CANCELLED, KMC_LO_INVALID_DOCUMENT_TYPE_NAME, KMC_LO_DOWNLOAD_DOCUMENT_FIELDS_ERROR, KMC_LO_SUBMIT_PNG, KMC_LO_SUBMIT_BITMAP, KMC_LO_START_SUBMIT_JOB_ERROR, KMC_LO_SUBMIT_DOCUMENT_IMAGES_ERROR, KMC_LO_START_SUBMIT_INVALID_JOB_ID, KMC_LO_SUBMIT_DOCUMENT_FILEIO_ERROR, KMC_LO_SUBMIT_DOCUMENT_FILE_CLOSE_ERROR, KMC_LO_SUBMIT_DOCUMENT_NO_IMAGE_ERROR, KMC_LO_PAGE_IMAGE_INDEX_INVALID, KMC_LO_SUBMIT_DOCUMENT_MIMETYPE_ERROR, KMC_LO_SUBMIT_DOCUMENT_IMAGE_REP_ERROR, KMC_LO_SUBMIT_DOCUMENT_IMAGE_FILE_MISSING, KMC_LO_OPERATION_CANCEL_ERROR, KMC_LO_INVALID_SESSION_STATE_TRANSITION, KMC_LO_REGISTERING_NOT_ALLOWED, KMC_LO_DOWNLOAD_DOCUMENT_SCAN_SETTINGS_ERROR, KMC_LO_EVENT_LOCK_ACQUIRE_ERROR, KMC_LO_SERVER_CONNECTION, KMC_LO_SECURE_CONNECTION_UNAVAILABLE, KMC_LO_REQUEST_TIMEOUT, KMC_LO_NETWORK_NOT_REACHABLE, KMC_LO_NETWORK_AUTHENTICATION, KMC_LO_NETWORK_HOST_UNAVAILABLE, KMC_LO_WEB_SERVICE_FAILED, KMC_LO_REGISTER_REQUIRES_AUTH, KMC_LO_INVALID_CERTIFICATE, KMC_LO_LAST }
	Logistics Errors enum. More...

enum	kfxErrorImageProcessor { IP_BASE = KMC_IP_BASE, KMC_IP_NO_PROFILE, KMC_IP_NO_REPRESENTATION, KMC_IP_CONTEXT, KMC_IP_LICENSE_INVALID, KMC_IP_LICENSE_EXPIRED, KMC_IP_LICENSE_ALREADY_SET, KMC_IP_BAD_FILENAME, KMC_IP_IMAGE_BUFFERED, KMC_IP_JAILBREAK_DETECTED, KMC_IP_NO_CONFIGURATION, KMC_IP_LAST }
	Image Processor Errors enum. More...

enum	kfxErrorEv { KMC_EV_UNKNOWN = KMC_EV_BASE, KMC_EV_MEMORY, KMC_EV_FILEOPEN, KMC_EV_BAD_DPI, KMC_EV_BAD_WIDTH_HEIGHT, KMC_EV_BAD_LINEWIDTH, KMC_EV_BAD_CHANNEL, KMC_EV_METADATA_OVERFLOW, KMC_EV_FILE_READ_FAILED, KMC_EV_IMAGE_PARM, KMC_EV_IMAGE_PROCESSING, KMC_EV_IMAGE_WRITE_FAILED, KMC_EV_UNKNOWN_FILETYPE, KMC_EV_NONEXISTANT_IMAGE, KMC_EV_BAD_FILE_FORMAT, KMC_EV_APPEND_TO_FILE, KMC_EV_CANNOT_APPEND, KMC_EV_PDF_BAD, KMC_EV_APPEND_ENCRYPTED, KMC_EV_PDF_TOO_LARGE, KMC_EV_SPEED_ACCURACY, KMC_EV_FILE_METADATA, KMC_EV_INVALID_HANDLE, KMC_EV_EXTERNAL_PAGE, KMC_EV_HISTOGRAM, KMC_EV_INVALID_POINTER, KMC_EV_BARCODE_DRIVER, KMC_EV_LICENSING, KMC_EV_LICENSE_EXPIRED, KMC_EV_LOCK_CREATION_ERROR, KMC_EV_FILE_IO_ACCESS_BUSY, KMC_EV_PROCESS_PAGE_BUSY, KMC_EV_USER_ABORT, KMC_EV_META_DATA, KMC_EV_OP_STRING, KMC_EV_INI_FORMAT, KMC_EV_XML_FORMAT, KMC_EV_JSON_FORMAT, KMC_EV_LAST }
	Image Perfection Errors enum. More...

enum	kfxClassifier { KMC_CL_UNKNOWN = KMC_CL_BASE, KMC_CL_CONFIG_NULL, KMC_CL_CONFIG_NOT_LOADED, KMC_CL_MODEL_NULL, KMC_CL_MODEL_NOT_LOADED, KMC_CL_LISTENER_NULL, KMC_CL_MAX_NUM_RESULTS_INVALID, KMC_CL_CLASSIFIER_BUSY, KMC_CL_CLASSIFIER_NOT_INITIALIZED, KMC_CL_INVALID_IMAGE_SUPPLIED, KMC_CL_NO_IMAGE_SUPPLIED, KMC_CL_CLASSIFICATION_CONFIDENCE_LOW, KMC_CL_ID_CLASS_NOT_SUPPORTED, KMC_CL_LAST }

enum	kfxErrorUtilities { KUT_BASE = KMC_UT_BASE, KMC_UT_STATS_RECORDING_NOT_OFF, KMC_UT_STATS_FILEPATH_IS_NULL, KMC_UT_STATS_EXPORT_HANDLER_MISSING, KMC_UT_STATS_NOTHING_TO_PURGE, KMC_UT_STATS_INIT_NOT_ALLOWED, KMC_UT_STATS_PURGE_NOT_ALLOWED, KMC_UT_STATS_EXPORT_NOT_ALLOWED, KMC_UT_STATS_RECORD_NOT_ALLOWED, KMC_UT_STATS_WRITING_NOT_ALLOWED, KMC_UT_STATS_ALREADY_RECORDING, KMC_UT_STATS_ALREADY_EXPORTING, KMC_UT_STATS_ALREADY_WRITING, KMC_UT_STATS_UNINITIALIZED, KMC_UT_STATS_STATE_BUSY, KMC_UT_STATS_INVALID_STATE_TRANSITION, KMC_UT_CREATE_DB_FAILED, KMC_UT_OPEN_DB_FAILED, KMC_UT_DB_INVALID_SCHEMA, KMC_UT_WRITEFILE_FAILED, KMC_UT_INVALID_EVENT, KMC_UT_NO_OBJECT, KMC_UT_STATS_RECORD_AND_WRITING_NOT_ALLOWED, KMC_UT_STATS_EVENT_THROTTLED, KMC_UT_STATS_NOTHING_TO_EXPORT, KMC_UT_STATS_INVALID_JSON, KMC_UT_STATS_RECORDING_NOT_ON, KMC_UT_STATS_DATASTORE_OUT_OF_DATE, KMC_UT_STATS_DATASTORE_UPGRADE_FAILED, KMC_UT_STATS_DATASTORE_NO_UPGRADE_PATH, KMC_UT_STATS_DATASTORE_UPGRADE_NOT_NEEDED, KMC_UT_STATS_DATASTORE_UPGRADE_WRONG_STATE, KMC_UT_STATS_DATASTORE_UPGRADE_MISSING_FILE, KMC_UT_STATS_LOG_SESSION_EVENT_NOT_ALLOWED, KMC_UT_STATS_DEVICE_ID_MISSING, KMC_UT_STATS_RECORDING_ALREADY_STOPPED, KMC_UT_STATS_NO_SESSION_BEGUN, KMC_UT_STATS_BEGIN_SESSION_NOT_ALLOWED, KMC_UT_STATS_SESSION_ALREADY_BEGUN, KMC_UT_STATS_END_SESSION_NOT_ALLOWED, KMC_UT_LICENSE_IMAGE_PROCESSING, KMC_UT_LICENSE_IMAGE_CAPTURE, KMC_UT_LICENSE_BARCODE_CAPTURE, KMC_UT_LICENSE_ON_DEVICE_EXTRACTION, KMC_UT_LICENSE_UNKNOWN_LICENSE_SERVER_TYPE, KMC_UT_OUT_OF_VOLUME_LICENSE, KMC_UT_LICENSING_NETWORK_EXCEPTION, KMC_UT_LAST }
	Utilities Errors enum. More...

enum	kfxErrorBarcodeReader { KMC_BC_NONE = KMC_BC_BASE+1, KMC_BC_UNKNOWN, KMC_BC_BAD_FILENAME, KMC_BC_IMAGE_BUFFERED, KMC_BC_NO_DIRECTIONS, KMC_BC_NO_SYMBOLOGIES, KMC_BC_NO_REPRESENTATION, KMC_BC_INVALID_IMAGE, KMC_BC_BUSY, KMC_BC_NO_BARCODE_FOUND, KMC_BC_LAST }
	An enumeration containing the different error return types. More...

enum	kfxErrorExtraction { KMC_EX_UNKNOWN = KMC_EX_BASE, KMC_EX_PARSE_RESPONSE, KMC_EX_FORM_REQUEST, KMC_EX_CREDENTIALS, KMC_EX_INTERNAL_SERVER, KMC_EX_ONDEVICE_EXTRACTION_NOT_SUPPORTED, KMC_EX_UNSUPPORTED_REGION, KMC_EX_CLASSIFICATION_CONFIG_NOT_FOUND, KMC_EX_PROCESSING_CONFIG_NOT_FOUND, KMC_EX_EXTRACTION_CONFIG_NOT_FOUND, KMC_EX_CLASSIFICATION_FAILED, KMC_EX_PROCESSING_FAILED, KMC_EX_EXTRACTION_FAILED, KMC_EX_OCR_FAILED, KMC_EX_BUSY, KMC_EX_NOIMAGE, KMC_EX_NOREGION, KMC_EX_CANCEL_OPERATION_SUCCESS, KMC_EX_INVALID_BARCODE_STRING, KMC_EX_ASSET_INTEGRITY_FAILURE, KMC_EX_BUNDLE_NOT_FOUND, KMC_EX_PROJECT_ALREADY_LOADING, KMC_EX_OPEN_ARCHIVE_FAILED, KMC_EX_SESSIONID_NOT_FOUND, KMC_EX_ENCRYPTED_BARCODE_STRING, KMC_EX_LAST }
	Extraction errors enum. More...

Macro Definition Documentation

◆ KFX_ERROR_DOMAIN

#define KFX_ERROR_DOMAIN @"com.kofax.mobilesdk"

◆ KMC_BC_BASE

#define KMC_BC_BASE 0xB000

◆ KMC_CD_BASE

#define KMC_CD_BASE 0x4000

◆ KMC_CL_BASE

#define KMC_CL_BASE 0xC000

◆ KMC_ED_BASE

#define KMC_ED_BASE 0x6000

◆ KMC_EV_BASE

#define KMC_EV_BASE 0xE000

◆ KMC_EX_BASE

#define KMC_EX_BASE 0x8000

◆ KMC_GN_BASE

#define KMC_GN_BASE 0x1000

◆ KMC_IP_BASE

#define KMC_IP_BASE 0x5000

◆ KMC_LO_BASE

#define KMC_LO_BASE 0x3000

◆ KMC_SUCCESS

#define KMC_SUCCESS 0

◆ KMC_UI_BASE

#define KMC_UI_BASE 0x2000

◆ KMC_UT_BASE

#define KMC_UT_BASE 0x7000

Typedef Documentation

◆ KFX_ERROR_BARCODE_READER

typedef enum kfxErrorBarcodeReader KFX_ERROR_BARCODE_READER

An enumeration containing the different error return types.

◆ KFX_ERROR_CLASSIFIER

typedef enum kfxClassifier KFX_ERROR_CLASSIFIER

◆ KFX_ERROR_ENGINE_DATA

typedef enum kfxKedErrorEngineData KFX_ERROR_ENGINE_DATA

Engine Data Errors enum.

This enum defines the engine data errors that the image class and the image processing methods return.
These errors are generated by objects associated with the engine data objects.

◆ KFX_ERROR_EXTRACTION

typedef enum kfxErrorExtraction KFX_ERROR_EXTRACTION

Extraction errors enum.

This enum defines errors that are associated with the extraction

◆ KFX_ERROR_GENERAL

typedef enum kfxErrorGeneral KFX_ERROR_GENERAL

General Errors enum.

This enum defines general errors that are not specific to any single component.

◆ KFX_ERROR_IMAGE_PROCESSOR

typedef enum kfxErrorImageProcessor KFX_ERROR_IMAGE_PROCESSOR

Image Processor Errors enum.

This enum defines the errors associated with image processing.

◆ KFX_ERROR_LOGISTICS_ERRORS

typedef enum kfxErrorLogistics KFX_ERROR_LOGISTICS_ERRORS

Logistics Errors enum.

This enum defines the errors associated with Logistics, if your SDK package includes Logistics.

◆ KFX_ERROR_PERFECTION

typedef enum kfxErrorEv KFX_ERROR_PERFECTION

Image Perfection Errors enum.

This enum defines the errors associated with image perfection algorithms.

◆ KFX_ERROR_UICONTROLS_ERRORS

typedef enum kfxErrorUIControls KFX_ERROR_UICONTROLS_ERRORS

UI Control Errors enum.

This enum defines the errors associated with UI controls.

◆ KFX_ERROR_UTILITIES

typedef enum kfxErrorUtilities KFX_ERROR_UTILITIES

Utilities Errors enum.

This enum defines errors that are associated with the utilities framework.

Enumeration Type Documentation

◆ kfxClassifier

enum kfxClassifier

Enumerator
KMC_CL_UNKNOWN
KMC_CL_CONFIG_NULL
KMC_CL_CONFIG_NOT_LOADED
KMC_CL_MODEL_NULL
KMC_CL_MODEL_NOT_LOADED
KMC_CL_LISTENER_NULL
KMC_CL_MAX_NUM_RESULTS_INVALID
KMC_CL_CLASSIFIER_BUSY
KMC_CL_CLASSIFIER_NOT_INITIALIZED
KMC_CL_INVALID_IMAGE_SUPPLIED
KMC_CL_NO_IMAGE_SUPPLIED
KMC_CL_CLASSIFICATION_CONFIDENCE_LOW
KMC_CL_ID_CLASS_NOT_SUPPORTED
KMC_CL_LAST

◆ kfxErrorBarcodeReader

enum kfxErrorBarcodeReader