idrserr_interface.h

Go to the documentation of this file.

 
#ifndef _IDRSERR_INTERFACE_
#define _IDRSERR_INTERFACE_
 
typedef unsigned long IDRS_ERROR;
#define IDRS_SUCCESS                          0
/*
 * ======================================
 * Generic errors.
 * ======================================
 */
#define IDRS_ERROR_FAILURE                    1
#define IDRS_ERROR_MEMORY_ALLOCATION          2
#define IDRS_ERROR_TODO_METHOD                3
#define IDRS_ERROR_LIBRARY_MISSING            4
#define IDRS_ERROR_TODO_METHOD_LINUX          5
#define IDRS_ERROR_TODO_METHOD_MACOS          6
#define IDRS_ERROR_TODO_METHOD_WINDOWS        7
#define IDRS_ERROR_BUFFER_TOO_SMALL           9
#define IDRS_ERROR_USER_ABORT                11
#define IDRS_ERROR_TODO_METHOD_IOS           14
#define IDRS_ERROR_BUFFER_IS_FULL 17
#define IDRS_ERROR_INVALID_MODULE 18
#define IDRS_ERROR_FILE_NAME_NOT_EXIST 19
#define IDRS_ERROR_MUTEX_CREATION_FAILURE 20
#define IDRS_ERROR_TEMPORARY_LICENSE_EXPIRED  22
#define IDRS_ERROR_TODO_METHOD_ANDROID          23
#define IDRS_ERROR_NOT_SUPPORTED 24
#define IDRS_ERROR_THREAD_CREATION_FAILURE 26
#define IDRS_ERROR_THREAD_WAIT_FAILURE 27
#define IDRS_ERROR_MUTEX_LOCK_FAILURE  28
#define IDRS_ERROR_MUTEX_RELEASE_FAILURE  29
#define IDRS_ERROR_MEMORY_OVER_MAX_LIMIT          30
#define IDRS_ERROR_MEMORY_MONITORING_AFTER_SETUP          31
/*
 * ======================================
 * File access errors.
 * ======================================
 */
#define IDRS_ERROR_FILE_SEEK                  1001
#define IDRS_ERROR_FILE_OPEN                  1002
#define IDRS_ERROR_FILE_FORMAT                1003
#define IDRS_ERROR_READ_FAILURE               1004
#define IDRS_ERROR_WRITE_FAILURE              1005
#define IDRS_ERROR_INVALID_IMAGE_INDEX              1006
#define IDRS_ERROR_TEMPORARY_FILE_CREATE      1007
#define IDRS_ERROR_INVALID_IMAGE_LOAD_OPTIONS    1008
#define IDRS_ERROR_INVALID_IMAGE_SAVE_OPTIONS    1009
/*
 * ======================================
 * Arguments errors.
 * ======================================
 */
#define IDRS_ERROR_INVALID_ARGS               1101
#define IDRS_ERROR_INVALID_CALL               1102
#define IDRS_ERROR_INVALID_INDEX              1103
#define IDRS_ERROR_INVALID_RESOLUTION         1104
#define IDRS_ERROR_IMAGE_TOO_LARGE 1105
#define IDRS_ERROR_INVALID_PDF_PASSWORD 1106
#define IDRS_ERROR_PAGE_WITHOUT_OCR_RESULTS 1107
/*
 * ======================================
 * Character recognition module errors.
 * ======================================
 */
#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_IS_READY               1201
#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_NOT_READY              1202
#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_INVALID_KEY            1203
#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_LOAD_RECOGNITION_ENV   1204
#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_LOAD_DECISION_ENV      1205
#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_FAILURE                1206
#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_ASIAN_NOT_READY        1207
#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_HEBREW_NOT_READY       1208
#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_HAND_WRITE_NOT_READY          1209
#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_ARABIC_NOT_READY       1211
#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_ARABIC_FAILURE         1213
#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_UNEXPECTED_ZONE_TYPE 1216
#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_INVALID_LANGUAGE_COMBINATION 1217
/*
 * ======================================
 * Barcode recognition module errors.
 * ======================================
 */
#define IDRS_ERROR_BARCODE_IS_READY             1301
#define IDRS_ERROR_BARCODE_NOT_READY             1302
#define IDRS_ERROR_BARCODE_INVALID_KEY         1303
#define IDRS_ERROR_BARCODE_2D_NOT_READY       1304
#define IDRS_ERROR_BARCODE_FAILURE               1306
#define IDRS_ERROR_BARCODE_ENGINE_INVALID_RESPONSE 1308
#define IDRS_ERROR_BARCODE_ENGINE_SETUP_FAILURE 1309
#define IDRS_ERROR_BARCODE_ENGINE_NOT_REGISTERED  1310
#define IDRS_ERROR_BARCODE_ENGINE_NOT_AVAILABLE  1311
#define IDRS_ERROR_BARCODE_ENGINE_ALREADY_REGISTERED  1312
#define IDRS_ERROR_BARCODE_ENGINE_CANNOT_UNREGISTER  1313
/*
 * ======================================
 * Preprocessing module errors.
 * ======================================
 */
#define IDRS_ERROR_PREPRO_IS_READY             1401
#define IDRS_ERROR_PREPRO_NOT_READY            1402
#define IDRS_ERROR_PREPRO_INVALID_KEY          1403
#define IDRS_ERROR_PREPRO_FAILURE              1406
#define IDRS_ERROR_PREPRO_DESPECKLE_FAILURE    1407
#define IDRS_ERROR_PREPRO_DARKBORDER_REMOVAL_INVALID_MARGINS  1408
#define IDRS_ERROR_PREPRO_CAMERA_IMAGE_LIBRARY_NOT_READY 1409
#define IDRS_ERROR_PREPRO_CAMERA_IMAGE_FAILURE           1410
#define IDRS_ERROR_PREPRO_CAMERA_IMAGE_PERSPECTIVE_DISTORTION_TOO_LARGE    1411
/*
 * ======================================
 * Document output module errors.
 * ======================================
 */
#define IDRS_ERROR_DOCUMENT_OUTPUT_IS_READY                1501
#define IDRS_ERROR_DOCUMENT_OUTPUT_NOT_READY               1502
#define IDRS_ERROR_DOCUMENT_OUTPUT_FAILURE                 1503
#define IDRS_ERROR_DOCUMENT_OUTPUT_INVALID_KEY             1504
#define IDRS_ERROR_DOCUMENT_OUTPUT_CERTIFICATE_NOT_FOUND   1505
#define IDRS_ERROR_DOCUMENT_OUTPUT_HYPER_COMPRESSION_NOT_READY          1506
#define IDRS_ERROR_DOCUMENT_OUTPUT_HYPER_COMPRESSION_INVALID_KEY        1507
#define IDRS_ERROR_DOCUMENT_OUTPUT_PDFUA_REQUIREMENTS_NOT_REACHED 1508
/*
 * ======================================
 * Image formats module errors.
 * ======================================
 */
#define IDRS_ERROR_IMAGE_FORMATS_IS_READY           1601
#define IDRS_ERROR_IMAGE_FORMATS_NOT_READY          1602
#define IDRS_ERROR_IMAGE_FORMATS_FAILURE            1603
#define IDRS_ERROR_IMAGE_FORMATS_INVALID_KEY        1604
#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_NOT_READY     1609
#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_LICENSE_ERROR 1610
#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_UNKNOWN 1611
#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_TIMEOUT 1612
#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_PROCESS_FAILURE 1613
#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_INVALID_PASSWORD 1614
#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_CORRUPT 1617
#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_PAGE_ERROR 1618
#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_FONT_MISSING_GLYPH_INFO 1619
#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_UNSUPPORTED_CHARACTER 1620
#define IDRS_ERROR_EXTERNAL_PDF_UNEXPECTED_TYPE_FIELDS_REFERENCE_OBJECT 1621
#define IDRS_ERROR_EXTERNAL_PDF_UNEXPECTED_TYPE_FIELDS_OBJECT 1622
#define IDRS_ERROR_EXTERNAL_PDF_UNEXPECTED_TYPE_ACROFORM_OBJECT 1623
#define IDRS_ERROR_EXTERNAL_PDF_UNEXPECTED_TYPE_ANNOTS_OBJECT 1624
#define IDRS_ERROR_EXTERNAL_PDF_UNSUPPORTED_ENCRYPTION 1625
/*
 * ======================================
 * Extraction module errors
 * ======================================
 */
#define IDRS_ERROR_EXTRACTION_IS_READY   1701
#define IDRS_ERROR_EXTRACTION_NOT_READY  1702
#define IDRS_ERROR_EXTRACTION_INVALID_KEY 1704
/*
 * ======================================
 * JPEG 2000 compressor errors.
 * ======================================
 */
#define IDRS_ERROR_J2K_MIN_ERROR           1800
#define IDRS_ERROR_J2K_MAX_ERROR           1999
/*
 * ======================================
 * Document output kernel errors.
 * ======================================
 */
#define IDRS_ERROR_DOCUMENT_OUTPUT_KRN_MIN_ERROR           2000
#define IDRS_ERROR_DOCUMENT_OUTPUT_ENGINE_ASSERTION 2009
#define IDRS_ERROR_DOCUMENT_OUTPUT_ALLOC_CRITICAL_SIZE    2042
#define IDRS_ERROR_DOCUMENT_OUTPUT_XML_NOT_WELL_DONE 2043
#define IDRS_ERROR_DOCUMENT_OUTPUT_WORD_LIMITATION        2044
#define IDRS_ERROR_DOCUMENT_OUTPUT_API_PARAM_INCOHERENT   2110
#define IDRS_ERROR_DOCUMENT_OUTPUT_SIGNATURE_FAILURE   2145
#define IDRS_ERROR_DOCUMENT_OUTPUT_FONT_NOT_FOUND  2160
#define IDRS_ERROR_DOCUMENT_OUTPUT_XML_LOAD_IMPOSSIBLE    2301
#define IDRS_ERROR_DOCUMENT_OUTPUT_TTREADER_UNKNOWN       2400
#define IDRS_ERROR_DOCUMENT_OUTPUT_PDF_NO_PAGE          3170
#define IDRS_ERROR_DOCUMENT_OUTPUT_PREPRO_XTR             3200
#define IDRS_ERROR_DOCUMENT_OUTPUT_PREPRO_MRC             3201
#define IDRS_ERROR_DOCUMENT_OUTPUT_KRN_MAX_ERROR          5000
/*
 * ======================================
 * Warning codes.
 * ======================================
 */
#define IDRS_WARNING_MRC_JBIG2MASK_NOT_ALLOWED 9001
#define IDRS_WARNING_JPEG2000_NOT_ALLOWED 9004
#define IDRS_WARNING_MISSING_GLYPH_INFO 9005
#define IDRS_WARNING_ZERO_SIZE_ELEMENT 9008
/*
 * ======================================
 * C interface errors.
 * ======================================
 */
#define IDRS_C_SUCCESS IDRS_SUCCESS
#define IDRS_ERROR_C_INVALID_ARRAY_OBJECT_TYPE 20001
#define IDRS_ERROR_C_INVALID_OBJECT 20002
#define IDRS_ERROR_C_INVALID_OBJECT_TYPE 20003
#define IDRS_ERROR_C_INVALID_PARAMETER_TYPE 20004
#define IDRS_ERROR_C_NULL_OBJECT 20005
#define IDRS_ERROR_C_UNKNOWN_ERROR 20006
 
 // namespace
#endif /* _idrserr_h_ */