iDRS™ SDK 16
Loading...
Searching...
No Matches
idrserr_interface.h File Reference

This file contains the declaration of iDRS error codes. More...

Go to the source code of this file.

Macros

#define IDRS_SUCCESS   0
 
#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
 
#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
 
#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
 
#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
 
#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
 Barcode engine could not be properly setup due to invalid internal response.
 
#define IDRS_ERROR_BARCODE_ENGINE_SETUP_FAILURE   1309
 Barcode engine could not be properly setup due to library loading.
 
#define IDRS_ERROR_BARCODE_ENGINE_NOT_REGISTERED   1310
 The barcode engine is not registered. Please register the barcode engine with the supplied identifier using CBarcodeEngineManager.
 
#define IDRS_ERROR_BARCODE_ENGINE_NOT_AVAILABLE   1311
 The supplied barcode engine identifier is not yet available. Please make sure it is registered using.
 
#define IDRS_ERROR_BARCODE_ENGINE_ALREADY_REGISTERED   1312
 A barcode engine with the same unique identifier has been already registered.
 
#define IDRS_ERROR_BARCODE_ENGINE_CANNOT_UNREGISTER   1313
 There was an error while removing the specified barcode engine. Please note that the default barcode engines shipped with iDRS SDK cannot be unregistered.
 
#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
 The prepro camera image library is not currently loaded.
 
#define IDRS_ERROR_PREPRO_CAMERA_IMAGE_FAILURE   1410
 The prepro camera image library encountered an error while performing perspective correction.
 
#define IDRS_ERROR_PREPRO_CAMERA_IMAGE_PERSPECTIVE_DISTORTION_TOO_LARGE   1411
 The prepro camera image library detected a perspective distortion too large to allow correction while keeping the whole image.
 
#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
 
#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
 The input external pdf contains an unexpected object type while reading Fields object from AcroForm dictionary.
 
#define IDRS_ERROR_EXTERNAL_PDF_UNEXPECTED_TYPE_FIELDS_OBJECT   1622
 The input external pdf contains an unexpected object type while reading Fields object from AcroForm dictionary.
 
#define IDRS_ERROR_EXTERNAL_PDF_UNEXPECTED_TYPE_ACROFORM_OBJECT   1623
 The input external pdf contains an unexpected type for the AcroForm object in Catalog object.
 
#define IDRS_ERROR_EXTERNAL_PDF_UNEXPECTED_TYPE_ANNOTS_OBJECT   1624
 The input external pdf contains an unexpected type for Annots object on Page object.
 
#define IDRS_ERROR_EXTERNAL_PDF_UNSUPPORTED_ENCRYPTION   1625
 The input external pdf uses an unsupported encryption method.
 
#define IDRS_ERROR_EXTRACTION_IS_READY   1701
 Extraction module already initialized.
 
#define IDRS_ERROR_EXTRACTION_NOT_READY   1702
 Extraction module is not ready.
 
#define IDRS_ERROR_EXTRACTION_INVALID_KEY   1704
 Invalid extraction software key.
 
#define IDRS_ERROR_J2K_MIN_ERROR   1800
 
#define IDRS_ERROR_J2K_MAX_ERROR   1999
 
#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
 
#define IDRS_WARNING_MRC_JBIG2MASK_NOT_ALLOWED   9001
 Output image size is bigger than A1 at 300dpi, interpolation and JBIG2 compression won't be used.
 
#define IDRS_WARNING_JPEG2000_NOT_ALLOWED   9004
 Output image size is too small for Jpeg2000 compression, JPEG will be used instead.
 
#define IDRS_WARNING_MISSING_GLYPH_INFO   9005
 One or several glyphs could not be found and are missing from the output document.
 
#define IDRS_WARNING_ZERO_SIZE_ELEMENT   9008
 A text element provided to the document output engine contains only characters having a glyph width of 0.
 
#define IDRS_C_SUCCESS   IDRS_SUCCESS
 Success.
 
#define IDRS_ERROR_C_INVALID_ARRAY_OBJECT_TYPE   20001
 Invalid array object type.
 
#define IDRS_ERROR_C_INVALID_OBJECT   20002
 Invalid object.
 
#define IDRS_ERROR_C_INVALID_OBJECT_TYPE   20003
 Invalid object type.
 
#define IDRS_ERROR_C_INVALID_PARAMETER_TYPE   20004
 Invalid parameter type.
 
#define IDRS_ERROR_C_NULL_OBJECT   20005
 Object is null.
 
#define IDRS_ERROR_C_UNKNOWN_ERROR   20006
 Internal error.
 

Typedefs

typedef unsigned long IDRS_ERROR
 The IDRS_ERROR data type defines an error code.
 

Detailed Description

This file contains the declaration of iDRS error codes.

Macro Definition Documentation

◆ IDRS_ERROR_BARCODE_2D_NOT_READY

#define IDRS_ERROR_BARCODE_2D_NOT_READY   1304

Barcode 2D extension is not ready

◆ IDRS_ERROR_BARCODE_ENGINE_NOT_AVAILABLE

#define IDRS_ERROR_BARCODE_ENGINE_NOT_AVAILABLE   1311

The supplied barcode engine identifier is not yet available. Please make sure it is registered using.

See also
IDRS::CBarcodeEngineManager and enabled using
IDRS::CBarcodeDetailedParameters

◆ IDRS_ERROR_BARCODE_FAILURE

#define IDRS_ERROR_BARCODE_FAILURE   1306

Barcode engine failure.

◆ IDRS_ERROR_BARCODE_INVALID_KEY

#define IDRS_ERROR_BARCODE_INVALID_KEY   1303

Invalid barcode software key.

◆ IDRS_ERROR_BARCODE_IS_READY

#define IDRS_ERROR_BARCODE_IS_READY   1301

Barcode already initialized

◆ IDRS_ERROR_BARCODE_NOT_READY

#define IDRS_ERROR_BARCODE_NOT_READY   1302

Barcode is not ready

◆ IDRS_ERROR_BUFFER_IS_FULL

#define IDRS_ERROR_BUFFER_IS_FULL   17

The buffer is too full to append any string.

◆ IDRS_ERROR_BUFFER_TOO_SMALL

#define IDRS_ERROR_BUFFER_TOO_SMALL   9

The buffer used is too small.

◆ IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_ARABIC_FAILURE

#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_ARABIC_FAILURE   1213

An error occured in the Arabic OCR engine.

◆ IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_ARABIC_NOT_READY

#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_ARABIC_NOT_READY   1211

The arabic fonts recognition add-on is not ready.

◆ IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_ASIAN_NOT_READY

#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_ASIAN_NOT_READY   1207

The Asian OCR add-on is not ready.

◆ IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_FAILURE

#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_FAILURE   1206

Character recognition engine failure

◆ IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_HAND_WRITE_NOT_READY

#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_HAND_WRITE_NOT_READY   1209

The HAND_WRITE module is not ready.

◆ IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_HEBREW_NOT_READY

#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_HEBREW_NOT_READY   1208

The Hebrew OCR add-on is not ready.

◆ IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_INVALID_KEY

#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_INVALID_KEY   1203

Invalid Character recognition engine software key.

◆ IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_INVALID_LANGUAGE_COMBINATION

#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_INVALID_LANGUAGE_COMBINATION   1217

The language combination is invalid. Please see

See also
CLngUtils::TestCompatibility for details about mixing recognition languages

◆ IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_IS_READY

#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_IS_READY   1201

Character recognition engine already initialized

◆ IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_LOAD_DECISION_ENV

#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_LOAD_DECISION_ENV   1205

Unable to load a decision environment.

◆ IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_LOAD_RECOGNITION_ENV

#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_LOAD_RECOGNITION_ENV   1204

Unable to load a recognition environment.

◆ IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_NOT_READY

#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_NOT_READY   1202

Character recognition engine is not ready

◆ IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_UNEXPECTED_ZONE_TYPE

#define IDRS_ERROR_CHARACTER_RECOGNITION_ENGINE_UNEXPECTED_ZONE_TYPE   1216

The zone type found at segmentation does not match the zone type returned by recognition.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_ALLOC_CRITICAL_SIZE

#define IDRS_ERROR_DOCUMENT_OUTPUT_ALLOC_CRITICAL_SIZE   2042

The memory allocation for the document output module exceeds the maximum size.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_API_PARAM_INCOHERENT

#define IDRS_ERROR_DOCUMENT_OUTPUT_API_PARAM_INCOHERENT   2110

Parameters are not correctly set for the document output module.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_CERTIFICATE_NOT_FOUND

#define IDRS_ERROR_DOCUMENT_OUTPUT_CERTIFICATE_NOT_FOUND   1505

Specified certificate not found.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_ENGINE_ASSERTION

#define IDRS_ERROR_DOCUMENT_OUTPUT_ENGINE_ASSERTION   2009

The document output engine reached an unexpected state.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_FAILURE

#define IDRS_ERROR_DOCUMENT_OUTPUT_FAILURE   1503

Document output error.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_FONT_NOT_FOUND

#define IDRS_ERROR_DOCUMENT_OUTPUT_FONT_NOT_FOUND   2160

Font not available for embedding to the output document.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_HYPER_COMPRESSION_INVALID_KEY

#define IDRS_ERROR_DOCUMENT_OUTPUT_HYPER_COMPRESSION_INVALID_KEY   1507

Invalid advanced document output software key.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_HYPER_COMPRESSION_NOT_READY

#define IDRS_ERROR_DOCUMENT_OUTPUT_HYPER_COMPRESSION_NOT_READY   1506

Document output HyperCompression extension is not ready.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_INVALID_KEY

#define IDRS_ERROR_DOCUMENT_OUTPUT_INVALID_KEY   1504

Invalid document output module software key.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_IS_READY

#define IDRS_ERROR_DOCUMENT_OUTPUT_IS_READY   1501

Document output module already initialized.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_KRN_MAX_ERROR

#define IDRS_ERROR_DOCUMENT_OUTPUT_KRN_MAX_ERROR   5000

Document Output kernel errors max value

◆ IDRS_ERROR_DOCUMENT_OUTPUT_KRN_MIN_ERROR

#define IDRS_ERROR_DOCUMENT_OUTPUT_KRN_MIN_ERROR   2000

Document Output kernel errors min value

◆ IDRS_ERROR_DOCUMENT_OUTPUT_NOT_READY

#define IDRS_ERROR_DOCUMENT_OUTPUT_NOT_READY   1502

Document output module is not ready.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_PDF_NO_PAGE

#define IDRS_ERROR_DOCUMENT_OUTPUT_PDF_NO_PAGE   3170

Creating a document with no page

◆ IDRS_ERROR_DOCUMENT_OUTPUT_PDFUA_REQUIREMENTS_NOT_REACHED

#define IDRS_ERROR_DOCUMENT_OUTPUT_PDFUA_REQUIREMENTS_NOT_REACHED   1508

Requirements to activate PDF/UA are not reached:

  • PDF version should be 1.7 or later
  • Font embedding must be enabled
  • If PDF encryption is used, text access must be enabled

◆ IDRS_ERROR_DOCUMENT_OUTPUT_PREPRO_MRC

#define IDRS_ERROR_DOCUMENT_OUTPUT_PREPRO_MRC   3201

An error occurs when the prepro module processes the image on iHQC for the document output module.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_PREPRO_XTR

#define IDRS_ERROR_DOCUMENT_OUTPUT_PREPRO_XTR   3200

An error occurs when the prepro module extracts and processes the image for the document output module.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_SIGNATURE_FAILURE

#define IDRS_ERROR_DOCUMENT_OUTPUT_SIGNATURE_FAILURE   2145

Unable to apply signature to the output document.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_TTREADER_UNKNOWN

#define IDRS_ERROR_DOCUMENT_OUTPUT_TTREADER_UNKNOWN   2400

There is a problem in the font related input data for the document output module.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_WORD_LIMITATION

#define IDRS_ERROR_DOCUMENT_OUTPUT_WORD_LIMITATION   2044

The dimensions of a page from the output document exceeds the limitations of Word output format.

The limitations are the following:

  • The maximum number of columns and rows of a table are 63 and 32767 respectively.
  • The maximum page size is 22 inches width or height (55.88 cm)

Note that reaching the maximum page size often comes from an invalid resolution loaded from the input file.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_XML_LOAD_IMPOSSIBLE

#define IDRS_ERROR_DOCUMENT_OUTPUT_XML_LOAD_IMPOSSIBLE   2301

The input data for the document output module are not loaded successfully.

◆ IDRS_ERROR_DOCUMENT_OUTPUT_XML_NOT_WELL_DONE

#define IDRS_ERROR_DOCUMENT_OUTPUT_XML_NOT_WELL_DONE   2043

The input data for the document output module are not well formed.

◆ IDRS_ERROR_FAILURE

#define IDRS_ERROR_FAILURE   1

The function failed.

◆ IDRS_ERROR_FILE_FORMAT

#define IDRS_ERROR_FILE_FORMAT   1003

Invalid file format.

◆ IDRS_ERROR_FILE_NAME_NOT_EXIST

#define IDRS_ERROR_FILE_NAME_NOT_EXIST   19

The file path doesn't contain a file name.

◆ IDRS_ERROR_FILE_OPEN

#define IDRS_ERROR_FILE_OPEN   1002

Unable to open the file.

◆ IDRS_ERROR_FILE_SEEK

#define IDRS_ERROR_FILE_SEEK   1001

Unable to seek in the file.

◆ IDRS_ERROR_IMAGE_FORMATS_FAILURE

#define IDRS_ERROR_IMAGE_FORMATS_FAILURE   1603

Image formats error.

◆ IDRS_ERROR_IMAGE_FORMATS_INVALID_KEY

#define IDRS_ERROR_IMAGE_FORMATS_INVALID_KEY   1604

Invalid Image formats module software key.

◆ IDRS_ERROR_IMAGE_FORMATS_IS_READY

#define IDRS_ERROR_IMAGE_FORMATS_IS_READY   1601

Image formats module already initialized.

◆ IDRS_ERROR_IMAGE_FORMATS_NOT_READY

#define IDRS_ERROR_IMAGE_FORMATS_NOT_READY   1602

Image formats is not ready.

◆ IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_CORRUPT

#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_CORRUPT   1617

Image formats pdf corrupted

◆ IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_FONT_MISSING_GLYPH_INFO

#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_FONT_MISSING_GLYPH_INFO   1619

the pdf font is missing some glyph info

◆ IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_INVALID_PASSWORD

#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_INVALID_PASSWORD   1614

The password set to open the PDF is invalid.

◆ IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_LICENSE_ERROR

#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_LICENSE_ERROR   1610

Image formats pdf extension license is not correct

◆ IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_NOT_READY

#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_NOT_READY   1609

Image formats pdf extension not enabled.

◆ IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_PAGE_ERROR

#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_PAGE_ERROR   1618

Image formats pdf page not found or content error

◆ IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_PROCESS_FAILURE

#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_PROCESS_FAILURE   1613

Image formats pdf extension process failure

◆ IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_TIMEOUT

#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_TIMEOUT   1612

Image formats pdf extension timeout

◆ IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_UNKNOWN

#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_UNKNOWN   1611

Image formats pdf extension unknown error

◆ IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_UNSUPPORTED_CHARACTER

#define IDRS_ERROR_IMAGE_FORMATS_PDF_INPUT_UNSUPPORTED_CHARACTER   1620

the pdf contains some unsupprted characters

◆ IDRS_ERROR_IMAGE_TOO_LARGE

#define IDRS_ERROR_IMAGE_TOO_LARGE   1105

The number of pixels in the supplied image size exceeds the maximum allowed value Please see IDRS_MAX_IMAGE_DIMENSION_OCR

◆ IDRS_ERROR_INVALID_ARGS

#define IDRS_ERROR_INVALID_ARGS   1101

Invalid arguments for the method.

◆ IDRS_ERROR_INVALID_CALL

#define IDRS_ERROR_INVALID_CALL   1102

Invalid call to this method.

◆ IDRS_ERROR_INVALID_IMAGE_INDEX

#define IDRS_ERROR_INVALID_IMAGE_INDEX   1006

The supplied image index is invalid. This error might occur during image loading, when the image index is not correct (possibly larger than the number of images contained in the file)

◆ IDRS_ERROR_INVALID_IMAGE_LOAD_OPTIONS

#define IDRS_ERROR_INVALID_IMAGE_LOAD_OPTIONS   1008

The iDRS tries to load an image with invalid load options

◆ IDRS_ERROR_INVALID_IMAGE_SAVE_OPTIONS

#define IDRS_ERROR_INVALID_IMAGE_SAVE_OPTIONS   1009

The iDRS tries to load an image with invalid save options

◆ IDRS_ERROR_INVALID_INDEX

#define IDRS_ERROR_INVALID_INDEX   1103

The index is not valid.

◆ IDRS_ERROR_INVALID_MODULE

#define IDRS_ERROR_INVALID_MODULE   18

The module is invalid.

◆ IDRS_ERROR_INVALID_PDF_PASSWORD

#define IDRS_ERROR_INVALID_PDF_PASSWORD   1106

The PDF password supplied is invalid

◆ IDRS_ERROR_INVALID_RESOLUTION

#define IDRS_ERROR_INVALID_RESOLUTION   1104

The resolution is not valid.

◆ IDRS_ERROR_J2K_MAX_ERROR

#define IDRS_ERROR_J2K_MAX_ERROR   1999

JPEG 2000 compressor errors max value

◆ IDRS_ERROR_J2K_MIN_ERROR

#define IDRS_ERROR_J2K_MIN_ERROR   1800

JPEG 2000 compressor errors min value

◆ IDRS_ERROR_LIBRARY_MISSING

#define IDRS_ERROR_LIBRARY_MISSING   4

A library is missing.

◆ IDRS_ERROR_MEMORY_ALLOCATION

#define IDRS_ERROR_MEMORY_ALLOCATION   2

Unable to allocate a block of memory.

◆ IDRS_ERROR_MEMORY_MONITORING_AFTER_SETUP

#define IDRS_ERROR_MEMORY_MONITORING_AFTER_SETUP   31

The memory monitoring was enabled after setting up iDRS modules.

◆ IDRS_ERROR_MEMORY_OVER_MAX_LIMIT

#define IDRS_ERROR_MEMORY_OVER_MAX_LIMIT   30

The memory allocated by iDRS is above the maximum threshold

◆ IDRS_ERROR_MUTEX_CREATION_FAILURE

#define IDRS_ERROR_MUTEX_CREATION_FAILURE   20

Fail to create a mutex object.

◆ IDRS_ERROR_MUTEX_LOCK_FAILURE

#define IDRS_ERROR_MUTEX_LOCK_FAILURE   28

The iDRS failed to lock a mutex

◆ IDRS_ERROR_MUTEX_RELEASE_FAILURE

#define IDRS_ERROR_MUTEX_RELEASE_FAILURE   29

The iDRS failed to release a mutex

◆ IDRS_ERROR_NOT_SUPPORTED

#define IDRS_ERROR_NOT_SUPPORTED   24

This operation is not supported by the iDRS in its current configuration or on the current platform.

◆ IDRS_ERROR_PAGE_WITHOUT_OCR_RESULTS

#define IDRS_ERROR_PAGE_WITHOUT_OCR_RESULTS   1107

The Page has no ocr results

◆ IDRS_ERROR_PREPRO_DARKBORDER_REMOVAL_INVALID_MARGINS

#define IDRS_ERROR_PREPRO_DARKBORDER_REMOVAL_INVALID_MARGINS   1408

The margins set for dark border removal are invalid for the supplied image

◆ IDRS_ERROR_PREPRO_DESPECKLE_FAILURE

#define IDRS_ERROR_PREPRO_DESPECKLE_FAILURE   1407

Prepro despeckle failure.

◆ IDRS_ERROR_PREPRO_FAILURE

#define IDRS_ERROR_PREPRO_FAILURE   1406

Prepro failure.

◆ IDRS_ERROR_PREPRO_INVALID_KEY

#define IDRS_ERROR_PREPRO_INVALID_KEY   1403

Invalid pre-process software key.

◆ IDRS_ERROR_PREPRO_IS_READY

#define IDRS_ERROR_PREPRO_IS_READY   1401

Pre-process already initialized

◆ IDRS_ERROR_PREPRO_NOT_READY

#define IDRS_ERROR_PREPRO_NOT_READY   1402

Pre-process is not ready.

◆ IDRS_ERROR_READ_FAILURE

#define IDRS_ERROR_READ_FAILURE   1004

Read operation failed.

◆ IDRS_ERROR_TEMPORARY_FILE_CREATE

#define IDRS_ERROR_TEMPORARY_FILE_CREATE   1007

The iDRS was unable to create a temporary file.

◆ IDRS_ERROR_TEMPORARY_LICENSE_EXPIRED

#define IDRS_ERROR_TEMPORARY_LICENSE_EXPIRED   22

Key has expired

◆ IDRS_ERROR_THREAD_CREATION_FAILURE

#define IDRS_ERROR_THREAD_CREATION_FAILURE   26

The iDRS failed to create a thread

◆ IDRS_ERROR_THREAD_WAIT_FAILURE

#define IDRS_ERROR_THREAD_WAIT_FAILURE   27

The iDRS failed to join a thread

◆ IDRS_ERROR_TODO_METHOD

#define IDRS_ERROR_TODO_METHOD   3

This method isn't available yet.

◆ IDRS_ERROR_TODO_METHOD_ANDROID

#define IDRS_ERROR_TODO_METHOD_ANDROID   23

This method isn't available yet on Android

◆ IDRS_ERROR_TODO_METHOD_IOS

#define IDRS_ERROR_TODO_METHOD_IOS   14

This method isn't available yet on iOS

◆ IDRS_ERROR_TODO_METHOD_LINUX

#define IDRS_ERROR_TODO_METHOD_LINUX   5

This method isn't available yet on linux

◆ IDRS_ERROR_TODO_METHOD_MACOS

#define IDRS_ERROR_TODO_METHOD_MACOS   6

This method isn't available yet on mactel

◆ IDRS_ERROR_TODO_METHOD_WINDOWS

#define IDRS_ERROR_TODO_METHOD_WINDOWS   7

This method isn't available yet on Windows

◆ IDRS_ERROR_USER_ABORT

#define IDRS_ERROR_USER_ABORT   11

The user has aborted the current processing.

◆ IDRS_ERROR_WRITE_FAILURE

#define IDRS_ERROR_WRITE_FAILURE   1005

Write operation failed.

◆ IDRS_SUCCESS

#define IDRS_SUCCESS   0

Success.

◆ IDRS_WARNING_ZERO_SIZE_ELEMENT

#define IDRS_WARNING_ZERO_SIZE_ELEMENT   9008

A text element provided to the document output engine contains only characters having a glyph width of 0.

Remarks
In such case, a default size is used in order to avoid this invalid configuration.