|
RecAPI
|
Error information. More...
Error information.
The majority of RecAPI operations have the return value type RECERR. This is an enumeration type collecting all possible error codes in OmniPage CSDK v20. The integrating application should always check the return value of RecAPI functions to make sure that the function has successfully completed (REC_OK) its operation. Use this module to obtain information about errors that occured in the last operation, and see their categories.
| enum RECERR |
Error codes.
This is the type of the return value of almost all the function of RecAPI. The error codes can be grouped into some classes according to the module they come from. Thus the name of the enum type element can give some information about not only the type of the error, but also the module, where it has occured.
The functions kRecGetErrorInfo and kRecGetErrorUIText can give information about the specified error codes at runtime. During debugging, a useful tool can be the function watch_recerr.
L_ relate to the Layout Analyser. | REC_OK |
Successful operation, no error. |
| FILE_ERR |
File operation internal error. |
| FILE_SYNTAX_ERR |
File handling syntax error. |
| FILE_OPEN_ERR |
File open error. |
| FILE_NOTFOUND_ERR |
File not found. |
| FILE_READ_ERR |
File read error. |
| FILE_WRITE_ERR |
File write error. |
| FILE_ACCESS_ERR |
File access denied. |
| FILE_REMOVE_ERR |
File removal error. |
| FILE_CREATE_ERR |
File creation error. |
| FILE_SEEK_ERR |
File seek error. |
| FILE_MEM_ERR |
Out of memory during file I/O. |
| FILE_DISKFULL_ERR |
Disk full. |
| FILE_IO_ERR |
File I/O error. |
| FILE_SHARE_ERR |
Sharing violation. |
| FILE_ALREADYEXIST_ERR |
File already exists. |
| FILE_INVALIDFLAG_ERR |
Invalid flag specified in a function call. |
| FILE_INVALIDPARAMETER_ERR |
Invalid parameter specified in a function call. |
| FILE_LOCKVIOLATION_ERR |
File locking error. |
| FILE_DIRNOTEMPTY_ERR |
Directory is not empty. |
| FILE_INVALIDHANDLE_ERR |
Invalid handle specified in a function call. |
| FILE_TOOLARGE_ERR |
File size limit error. |
| FILE_MUTEX_NOTAVAILABLE_ERR |
Mutex is not available. |
| FILE_CANTCREATE_MUTEX_ERR |
Mutex cannot be created. |
| FILE_CANTRELEASE_MUTEX_ERR |
Mutex cannot be released. |
| FILE_INIT_ERR |
File system initialization error. |
| FILE_QUIT_ERR |
File Manager's module quit error. |
| FILE_NOT_IMPLEMENTED_ERR |
Function call not implemented yet. |
| FILE_INVALIDPOINTER_ERR |
Invalid pointer specified in a function call. |
| FILE_INVALIDFUNCTION_ERR |
The specified flag combination is not supported. |
| FILE_NOMORE_WARN |
Internal use only. |
| MEM_NOTENOUGH_ERR |
Not enough memory for this memory operation. |
| MEM_INVALIDPOINTER_ERR |
Invalid pointer to a memory object. |
| CHR_ILLEGALCODE_ERR |
Illegal internal code as a parameter. |
| CHR_ILLEGALSETTING_ERR |
Set parameter is not acceptable (e.g. size mismatch.) |
| CHR_NOMORE_WARN |
End of list of available Code Pages. |
| CHR_SETFILE_ERR |
Error while loading the Code Page Definition file (RECOGN.SET). |
| CHR_CODELENGTH_ERR |
Length of exported code exceeds buffer size. |
| CHR_MISSINGEXPORT_ERR |
Character conversion is not available for the given character. |
| CHR_LANGSET_CODEPAGE_ERR |
Conflict: The selected Code Page does not support some characters in the selected languages: there is no exact code in the Code Page for them. |
| CHR_INIT_ERR |
Character Set and Code Pages module initialization error. |
| CHR_MULTIPLELANG_FOUND_WARN |
There are more than one matching languages. |
| CHR_LANG_NOTFOUND_ERR |
There are no matching languages. |
| CHR_LANG_DISABLED_WARN |
The specified language is not enabled. |
| API_INCORRECTMODULEVERSION_ERR |
Inconsistent Engine configuration. |
| API_INIT_ERR |
Engine initialization error, or no appropriate license. |
| API_QUIT_ERR |
Engine termination error. |
| API_INIT_WARN |
Module initialization warning. |
| API_PROCESS_ABORTED_ERR |
Application has aborted the current process. |
| API_PROCESS_FINISH |
Application has terminated the current recognition process. Recognized text is kept. |
| API_MODULEMISSING_ERR |
Module not present or not licensed. |
| API_MODULELOAD_ERR |
OS could not load a module. |
| API_MODULEENTRY_ERR |
Missing entry in a module. |
| API_MODULEINVALID_ERR |
Invalid module. |
| API_MODULEINIT_ERR |
Module initialization error. |
| API_NOT_AVAILABLE_ERR |
The requested function is unavailable, or there is no appropriate license. |
| API_ERROR_ERR |
General error in the Engine. |
| API_GPFAULT_ERR |
General Protection Fault in the Engine. |
| API_PLATFORM_ERR |
Unsupported operating system. |
| API_STS_SYNTAX_ERR |
Syntax error in the specified Engine Settings file. |
| API_STS_ERR |
Invalid setting. |
| API_HARDLOCK_ERR |
Hardlock not found or hardlock service has not been started. |
| API_LICENSE_ERR |
Invalid license or Engine Licence file not found. |
| API_PARAMETER_ERR |
Invalid parameters. |
| API_BUSY_ERR |
Engine is busy. |
| API_EVALDATE_EXPIRED_ERR |
Evaluation date of the Engine has expired. |
| API_TIMEOUT_ERR |
Recognition process soft TimeOut. |
| API_FILEFORMAT_ERR |
Format error in the actual file. |
| API_INVALIDSESSION_ERR |
Current session is invalid. |
| NOT_IMPL_ERR |
Non-implemented feature. |
| API_DOTNET30_OR_LATER_MISSING_ERR |
Missing .NET 3.0 or later. |
| API_CRYPT_MISS_WARN |
Crypt module missing. |
| API_HARDTIMEOUT_ERR |
Recognition process hard TimeOut. |
| API_DOTNET40_OR_LATER_MISSING_ERR |
Missing .NET 4.0 or later. |
| API_LICENSEMGR_ERR |
License Manager error. |
| API_LICENSEVALIDATION_WARN |
License cannot be validated. |
| API_LANGUAGE_SET_ERR |
Unlicensed language setting found or it is not supported by the current CSDK configuration. |
| API_ERRORS_HAPPENED_WARN |
Non-fatal error happened during ProcessPages. |
| API_WARNINGS_HAPPENED_WARN |
Warnings happened during ProcessPages. |
| API_LICENSE_PAGECOUNT_ERR |
Page count limit reached or expired. |
| API_LICENSEMGR_PROTOCOL_ERR |
Connection actively closed by License Manager Service. |
| RSD_WARN |
General RSD warning. |
| RSD_INTERNAL |
Internal error. |
| RSD_FAIL |
General RSD failure. |
| RSD_NA |
Feature not available. |
| RSD_ACCESS |
Access violation. |
| RSD_CORRUPTED |
Internal data structures corrupted. |
| RSD_NOMEMORY |
No memory available. |
| RSD_MEMORYFAIL |
Failed to lock or free memory. |
| RSD_NOFILE |
File not found. |
| RSD_CREATEFAIL |
File creation error. |
| RSD_OPENFAIL |
File open error. |
| RSD_READONLY |
Read-only file attribute. |
| RSD_READFAIL |
File read error. |
| RSD_WRITEFAIL |
File write error. |
| RSD_CLOSEFAIL |
File close error. |
| RSD_FILECORRUPTED |
File structure corrupted. |
| RSD_NOMSGFILE |
Message text file not found. |
| RSD_NOMESSAGE |
Message not found. |
| RSD_DLL_NOFILE |
DLL not found. |
| RSD_DLL_FORMAT |
Invalid DLL format. |
| RSD_DLL_GETPROC |
Cannot find function in DLL. |
| RSD_NOTOPENED |
Scanner driver not opened. |
| RSD_NOTLOADED |
Scanner driver not loaded. |
| RSD_NODRIVER |
Scanner driver not found. |
| RSD_BADVERSION |
Invalid scanner driver version. |
| RSD_DRIVERFAIL |
Scanner driver error. |
| RSD_NOCARD |
Scanner interface card not found. |
| RSD_BADHANDLE |
Invalid spec ID. |
| RSD_PARAMID |
Invalid parameter ID specified. |
| RSD_PARAMVALUE |
Invalid parameter value specified. |
| RSD_BADADFCOMMAND |
Invalid ADF command. |
| RSD_WARNSTARTMODE |
Scan start mode setting not synchronized. |
| RSD_BADSTARTMODE |
Invalid scan start mode setting. |
| RSD_BADTRANSFER |
Invalid scan image transfer mode setting. |
| RSD_WARNPAPERSOURCE |
Scan paper source setting not synchronized. |
| RSD_BADPAPERSOURCE |
Invalid scan paper source setting. |
| RSD_WARNRESOLUTION |
Scan resolution setting not synchronized. |
| RSD_BADRESOLUTION |
Invalid scan resolution setting. |
| RSD_WARNMARGIN |
Scan margin setting not synchronized. |
| RSD_BADMARGIN |
Invalid scan margin setting. |
| RSD_WARNPAPERSIZE |
Scan paper size setting not synchronized. |
| RSD_BADPAPERSIZE |
Invalid scan paper size setting. |
| RSD_WARNORIENTATION |
Scan orientation setting not synchronized. |
| RSD_BADORIENTATION |
Invalid scan orientation setting. |
| RSD_WARNDUPLEX |
Duplex scan setting not synchronized. |
| RSD_BADDUPLEX |
Invalid duplex scan setting. |
| RSD_WARNIMAGEINTERP |
Bits per sample setting not synchronized. |
| RSD_BADIMAGEINTERP |
Invalid bits per sample setting. |
| RSD_BADCOLORINTERP |
Invalid color interpretation setting. |
| RSD_BADHALFTONE |
Invalid halftone setting. |
| RSD_WARNBRIGHTNESS |
Scan brightness setting not synchronized. |
| RSD_BADBRIGHTNESS |
Invalid scan brightness setting. |
| RSD_WARNCONTRAST |
Scan contrast setting not synchronized. |
| RSD_BADCONTRAST |
Invalid scan contrast setting. |
| RSD_BADMIDTONE |
Invalid scan midtone setting. |
| RSD_WARNLAMPCOLOR |
Scan dropout color setting not synchronized. |
| RSD_BADLAMPCOLOR |
Invalid scan dropout color setting. |
| RSD_BADCOMPRESSION |
Invalid compression setting. |
| RSD_BADFILETYPE |
Invalid image file type setting. |
| RSD_BADINDICATION |
Invalid scan indication setting. |
| RSD_CONFIGURATIONID |
Invalid configuration ID setting. |
| RSD_HOSTID |
Invalid host ID setting. |
| RSD_SCSIID |
Invalid SCSI ID setting. |
| RSD_BADPARAMCOMBO |
Invalid parameter combination. |
| RSD_LINE_TOO_WIDE |
Line too wide to handle. |
| RSD_NOIMAGE |
Image does not exist. |
| RSD_BADIMAGEWIDTH |
Image width too small or too large. |
| RSD_BADIMAGELENGTH |
Image length too small or too large. |
| RSD_NOAUTOROTATE |
Image too large for autorotate. |
| RSD_TRUNCATED |
User buffer too small. |
| RSD_NOTCAPABLE |
Scanner does not support this feature. |
| RSD_NOTCONNECTED |
Scanner not connected. |
| RSD_NOTREADY |
Scanner not ready. |
| RSD_NOPAPER |
Scanner ADF empty. |
| RSD_PAPERJAM |
Scanner ADF paper jam. |
| RSD_DOUBLEFEED |
Scanner ADF double feed. |
| RSD_COVEROPEN |
Scanner ADF cover open. |
| RSD_BOTHFEEDERSLOADED |
Both feeders are loaded. |
| RSD_RESERVED |
Scanner already reserved. |
| RSD_NOTRESERVED |
Scanner not reserved. |
| RSD_SCANNERBUSY |
Scanner busy. |
| RSD_SCANNERSTOP |
Stop button pushed on scanner. |
| RSD_SCANNERFAIL |
Unspecified scanner error. |
| RSD_TIMEOUT |
Timeout (RSD module or the scanner). |
| RSD_USER_CANCELLED |
User cancelled operation. |
| RSD_ABORTED |
Operation/action aborted. |
| RSD_NOTPOSSIBLE |
Operation not possible. |
| RSD_PAPERPICK |
The ADF cannot pick up the paper. |
| IMF_READ_ERR |
Image file read error. |
| IMF_WRITE_ERR |
Image file write error. |
| IMF_INIT_ERR |
Image file I/O module initialization error. |
| IMF_OPEN_ERR |
Image file open error. |
| IMF_CLOSE_ERR |
Image file close error. |
| IMF_CREATE_ERR |
Image file create error. |
| IMF_MEMORY_ERR |
Out of memory during image file I/O. |
| IMF_NOTSUP_ERR |
Not supported image file format or image file type. |
| IMF_TAGMISSING_ERR |
Required TIFF basic tag is missing. |
| IMF_COMP_ERR |
Error in image compression. |
| IMF_IMGFORM_ERR |
Unknown image format. |
| IMF_PAGENUM_ERR |
Non-existent page number. |
| IMF_FILEFORMAT_ERR |
File format error. |
| IMF_COLOR_ERR |
Color PCX file is not supported. |
| IMF_TMPFILE_ERR |
Temporary file handling error. |
| IMF_APPEND_ERR |
Appending not allowed. |
| IMF_FILENOTEMPTY_ERR |
Writing into a non-empty file without IMF append mode specified. |
| IMF_FAXVIEWMISS_ERR |
Microsoft Fax viewer missing or not installed. |
| IMF_PASSWORD_WARN |
Password protected file. |
| IMF_EMPTYHANDLE_WARN |
The file belonging to this handle does not exist any longer. |
| IMF_PDFAPPENDONLY_ERR |
In case of PDF saving the append flag must be true. |
| IMF_READ_WARN |
Image file read problem. |
| IMF_COMP_WARN |
Problem in image compression. |
| IMF_PASSWORD_SYNTAX_WARN |
Illegal password. |
| IMF_PASSWORD_ERR |
Wrong password. |
| IMF_CRYPT_NOTSUP_ERR |
Not supported encryption. |
| IMF_FONT_MISSING_WARN |
No font for rendering a glyph. |
| IMF_PDFCHANGEDXREF_WARN |
The pdf version is changed because the file size is over 10 GB. |
| IMF_FONT_MISSING_ERR |
No font for rendering the image. |
| IMG_SETTING_ERR |
Internal use only. |
| IMG_NOTENOUGHMEMORY_ERR |
Not enough memory during image processing. |
| IMG_RECT_ERR |
Invalid rectangle dimensions. |
| IMG_DPI_ERR |
Non-supported resolution. |
| IMG_NOTFOUND_ERR |
Image not found. |
| IMG_COMPRESSED_ERR |
Cannot process compressed image. |
| IMG_BITMAPADDRESS_ERR |
Invalid bitmap address. |
| IMG_BITSPERPIXEL_ERR |
Unsupported BitsPerPixel value. |
| IMG_NOTATTACHED_ERR |
Internal use only. |
| IMG_HANDLE_ERR |
Invalid image handle. |
| IMG_BUFFEROVERFLOW_ERR |
Buffer overflow during processing the image. |
| IMG_ACCESS_ERR |
Image operation denied. |
| IMG_NOMORE_WARN |
No more lines in defined image area. |
| IMG_SIZE_ERR |
Non-supported image size. |
| IMG_INVALIDOP_ERR |
Operation not supported on this image. |
| IMG_ZONE_ERR |
Invalid zone operation (e.g. existing user zone at LZ_FORM). |
| IMG_DPI_WARN |
Non-supported resolution. |
| IMG_ANCHOR_WARN |
One or more anchor zones were not found. |
| IMG_ANCHORNOTFOUND_ERR |
Too few anchors were found or none. |
| IMG_NOTEXTZONE_WARN |
No text zone in the template. |
| IMG_ANCHORNOTEXIST_ERR |
Neither positional nor reference anchor has been defined. |
| IMG_TEMPLATENOTMATCHED_ERR |
None of the templates were matched. |
| IMG_ANCHOR_CONTENT_ERR |
Not supported anchor content. |
| IMG_ANCHORMOREFOUND_WARN |
More than one anchor were found in the drift area. |
| IMG_TRANSFORM_ERR |
Zone transformation failed (zone is out of the image). |
| IMG_MATCHING_LOW_CONFIDENCE |
The matched template has low confidence. |
| IMG_ANCHOR_CHECKNOTFOUND_ERR |
The text in check anchor does not match. |
| IMG_ANCHOR_REFERENCENOTFOUND_ERR |
Reference anchor was not found. |
| IMG_ANCHOR_MOREREFERENCE_ERR |
The position of the reference anchor is ambiguous (there is similar text near the anchor). |
| IMG_ANCHOR_SELECTORNOTFOUND_ERR |
Selector anchor not found. |
| IMG_ANCHOR_RECOGNITION_ERR |
Could not recognize text or barcode in the given area. |
| IMG_ANCHOR_SKIP_WARN |
The anchor is skipped because template does not match. |
| IMG_ANCHOR_VALUE_WARN |
Anchor text is too short. |
| IMG_ANCHOR_ZONEISNOTANCHORED_WARN |
Zone is not anchored to either reference anchor or to positional anchor. |
| IMG_ANCHOR_TOOFEWANCHORS_WARN |
There are too few positional anchors (suggested: 4 - 6 anchors). |
| IMG_ANCHOR_TOOMANYANCHORS_WARN |
There are too many positional anchors (suggested: 4 - 6 anchors). |
| IMG_ANCHOR_POSITION_WARN |
The position of the anchors is suboptimal (define anchors near each corner of the page). |
| IMG_ANCHOR_SIMILARTEXT_WARN |
The anchor is ambigous: there is similar text near the anchor. |
| IMG_ANCHOR_NOTREFERENCED_WARN |
No zone is anchored to this reference anchor. |
| IMG_ANCHOR_CHECKDRIFTTOOLARGE_WARN |
The drift of the check anchor is too large (suggested: approx. DPI/30 pixel). |
| IMG_ANCHOR_DRIFTNOTCONSISTENT_WARN |
The drifts of some positional anchors are infinite, while those of others aren't. (Suggestion: either all of them or none of them should be infinite. |
| IMG_ANCHOR_CHECKANCHORSKIPPED_WARN |
The checkanchor(s) is/are skipped because there is no positional anchor. |
| IMG_TEMPLATEFAILED_WARN |
None of the templates were matched. |
| DC_INVALIDNAME_ERR |
Cannot create class: invalid name. |
| DC_EXISTINGNAME_ERR |
Cannot create class: existing name. |
| DC_EXISTINGFOLDER_ERR |
Cannot create class: existing folder. |
| DC_HANDLE_ERR |
Invalid handle. |
| DC_EMPTYCLASS_ERR |
Class is empty. |
| DC_NOTSAVED_ERR |
Project is not saved. |
| DC_NOTTRAINED_ERR |
Project is not trained. |
| DC_NOSUCHATTRIBUTE_ERR |
No such attribute. |
| DC_UNKNOWNEXTENSION_ERR |
Can not open this file: unknown extension. |
| DC_NOSUCHCLASS_ERR |
No such class. |
| DC_NOTEXT_ERR |
Document does not contain enough words to distinguish classes. |
| DC_ONECLASS_ERR |
There is only one class in the training set. |
| DC_TOOFEWDOCUMENT_WARN |
There are not enough documents in the class. |
| DC_NOTENOUGHINFO_WARN |
Document does not contain enough info to distinguish classes. |
| DC_INCOMPATIBLEDOCTYPE_ERR |
Layout based classifiers can not process text documents. |
| DC_SYNTAX_ERR |
Parameter syntax error. |
| DC_NOCLASS_ERR |
There is no class in the training set. |
| PAGE_NOTFOUND_ERR |
Invalid page handle (NULL). |
| PAGE_HANDLE_ERR |
Invalid page handle. |
| PAGE_NOT_IN_PAGESTORE_ERR |
Page is not in PageStore. |
| MGR_ERR |
Engine manager module error. |
| NO_TXT_WARN |
No recognized text available: either because the zone is empty or the required recognition module has not been initialized properly. |
| OCR_NO_MODULE_WARN |
No selected recognition module. |
| ZONE_NOTFOUND_ERR |
No zone in the zone list. |
| ZONE_NOTFOUND_WARN |
No zones found. |
| ZONE_POSITION_ERR |
Invalid zone index. |
| ZONE_EXISTING_SEQ_ERR |
Internal use only. |
| ZONE_FILE_ERR |
Internal use only. |
| ZONE_SIZE_ERR |
Invalid zone coordinates. |
| ZONE_SHAPE_ERR |
Invalid zone shape (not rectangular). |
| ZONE_IMAGE_DOWNSAMPLED_WARN |
Color image was downsampled. |
| ZONE_SIZE_WARN |
Invalid zone coordinates. |
| ZONE_NO_FIELDNAME_WARN |
Zone can not have a field name defined. |
| EXTRACTED_TXT_WARN |
Limited information extacted from input document. |
| LANGDET_INHERITED_WARN |
The language was inherited from previous page. |
| ZONE_OUTOFTHEIMAGE_ERR |
Zone is out of the image. |
| API_MTX_INTERNAL_ERR |
MTX engine fatal internal error. |
| MOR_INIT_ERR |
MOR recognition module initialization error. |
| MOR_DOS_ERR |
DOS error during recognition. |
| MOR_BCTNOTFOUND_ERR |
Knowledge base file for MOR recognition module not found (RECOGN.BCT). |
| MOR_BCTCORRUPTED_ERR |
Knowledge base file for MOR recognition module corrupted (RECOGN.BCT). |
| MOR_BCTVERSION_ERR |
Incorrect knowledge base file version (RECOGN.BCT). |
| MOR_TOOLARGE_ERR |
Image size too large. |
| MOR_FILECORRUPTED_ERR |
File corrupted. |
| MOR_INTERNAL_ERR |
Internal error in the MOR recognition module. |
| MOR_GPFAULT_ERR |
General Protection Fault in the MOR recognition module. |
| BAR_ERR |
Barcode module error. |
| BAR_NOT_ENOUGH_MEMORY_ERR |
Not enough memory for barcode recognition. |
| BAR_NO_CODE_ERR |
No barcode found in the zone. |
| BAR_INVALID_CODE_ERR |
Non-supported barcode type found. |
| BAR_NOT_DEFINIT_ERR |
Inconsistent type setting. |
| BAR_INCOMPATIBLE_TYPE_ERR |
Mutually exclusive type setting. |
| BAR_DEPRECATED_TYPE_ERR |
Deprecated type setting. |
| BAR_TYPE_WARN |
Barcode type incompatibility detected at kRecRecognize(). |
| BAR_UNCOMBINABLE_TYPE_ERR |
Code cannot be selected in combination with other symbologies. |
| BAR_NOTSUPPORTED_TYPE_ERR |
Not supported barcode type by actual bar recognition module. |
| BAR_FAMILY_FORCED_WARN |
Force family barcode type if the recognized type is not fit to the enabled type. |
| BAR_TOOLARGE_ERR |
Box is too small for the barcode. |
| BAR_NOTSUPPORTED_CHAR_WARN |
Character code is not supported by the actual barcode type. |
| DOT_ERR |
Dot-matrix recognition error. |
| OMR_ERR |
Checkmark recognition error. |
| HNR_TBSCORRUPTED_ERR |
Knowledge base file for HNR module corrupted. |
| HNR_SYNTAX_WARN |
Parameter is out of valid range. |
| RER_INTERNAL_ERR |
RER module internal error. |
| RER_NOKNOWLEDGEFILE_ERR |
Knowledge base file for RER module not found (*.REC). |
| RER_NOCHARSET_SET_ERR |
Character Set is empty for the RER module. |
| RER_NOTSUPPORTED_CHARSET_ERR |
The specified Character Set not fully supported by the RER recognition module. |
| RER_SPECFILE_NOTFOUND_ERR |
RER specfile not found. |
| SPL_MEMORY_ERR |
Not enough memory for the SPL module. |
| SPL_NOINIT_ERR |
Uninitialized spell object. |
| SPL_FOPEN_ERR |
Spell file open error. |
| SPL_FREAD_ERR |
Spell file read error. |
| SPL_FWRITE_ERR |
User dictionary write error. |
| SPL_BADFILEFORMAT_ERR |
Invalid file format (TEV.SZO). |
| SPL_INIT_ERR |
Module initialization error. |
| SPL_CLOSE_ERR |
User dictionary close error. |
| SPL_LANG_ERR |
Illegal language setting. |
| SPL_HANDLE_ERR |
Internal spell function call with a wrong handle. |
| SPL_NOMORE_WARN |
No more suggestions/items available. |
| SPL_INTERNAL_ERR |
Internal checking error. |
| SPL_DUPWORD_ERR |
Item already exists in the User dictionary. |
| SPL_NOTFOUND_ERR |
Item does not exist in the User dictionary. |
| SPL_BADWORD_ERR |
Item is incorrect (NULL pointer, empty word). |
| SPL_UDSECT_ERR |
Deprecated. |
| SPL_REGEXP_SYNTAX_ERR |
Regexp: other syntax error. |
| SPL_EXISTSECT_WARN |
Deprecated. |
| SPL_REGEXP_NOMATCH_ERR |
Regexp: item does not match. |
| SPL_REGEXP_NOMATCH_WARN |
Regexp: item does not match. |
| SPL_REGEXP_EXCLUSIVE_ERR |
Regexp: exclusive predefined set within set definition. |
| SPL_REGEXP_WRONGRANGE_ERR |
Regexp: a range in a set is not correct, e.g.: [z-a]. |
| SPL_REGEXP_SETINRANGE_ERR |
Regexp: a range with a predefined set, e.g.: [\w-z]. |
| SPL_REGEXP_INVALIDCHR_ERR |
Regexp: not handled Unicode character. |
| SPL_REGEXP_UNBALANCED1_ERR |
Regexp: unbalanced '(' or ')'. |
| SPL_REGEXP_UNBALANCED2_ERR |
Regexp: unbalanced '['. |
| SPL_REGEXP_UNBALANCED3_ERR |
Regexp: unbalanced '{'. |
| SPL_REGEXP_WRONGNUMBER_ERR |
Regexp: number(s) expected within {} pair. |
| SPL_REGEXP_WRONGUPPER_ERR |
Regexp: invalid upper limit in {n,m} multiplicator. |
| SPL_REGEXP_ESCAPE_ERR |
Regexp: illegal use of escape ('\') character. |
| SPL_REGEXP_HEXA_ERR |
Regexp: illegal hexadecimal spec.. |
| SPL_REGEXP_MULTIPLICATOR_ERR |
Regexp: illegal use of *, +, ? or {}. |
| SPL_REGEXP_ZERO_WIDTH_ERR |
Regexp: '?', '*', '+' or '{}' follows an empty atom. |
| SPL_REGEXP_UNEXPECTED_ERR |
Regexp: unexpected character found (missing escape?). |
| APIP_INIT_ERR |
APIPlus initialization error. |
| APIP_PARAM_ERR |
Parameter error. |
| APIP_NOMORE_WARN |
No more items available. |
| APIP_INTERNAL_ERR |
Internal error in RecAPIPlus. |
| L_WARNINGS |
General OmniPage Document (OPD) Warning. |
| L_WARNING_NOTFOUND |
Layout Analyser Object not found. |
| L_WARNING_NOTOPENED |
Layout Analyser Object not opened. |
| L_WARNING_MISSING |
Missing data. |
| L_WARNING_SUBSTITUTED |
Data substitution. |
| L_ERRORS |
General OmniPage Document (OPD) Error. |
| L_ERROR_NOID |
No such Object ID. |
| L_ERROR_OBJID |
Wrong Object ID. |
| L_ERROR_OBJTYPE |
Wrong object type. |
| L_ERROR_FILE |
General file operation error. |
| L_ERROR_FILE_OPEN |
File cannot be opened. |
| L_ERROR_FILE_CLOSE |
File cannot be closed. |
| L_ERROR_FILE_SEEK |
File seeking error. |
| L_ERROR_FILE_READ |
File reading error. |
| L_ERROR_FILE_WRITE |
File writing error. |
| L_ERROR_FILE_FORMAT |
Wrong file format. |
| L_ERROR_PARAMETER |
Invalid internal parameter. |
| L_ERROR_RANGE |
Invalid internal range. |
| L_ERROR_CALL |
Invalid function call. |
| L_ERROR_CONVERTER |
Conversion error. |
| L_ERROR_BADVERSION |
Wrong Layout Analyser version. |
| L_ERROR_IMAGE |
Image operation error. |
| L_ERROR_DTK |
DTK function error. |
| L_ERROR_READONLY |
Layout Analyser opened as read only. |
| L_ERROR_OUTPUT_MODE |
Invalid output mode. |
| L_ERROR_APPSET |
Invalid appset. |
| L_ERROR_PRERENDERING |
Prerendering error. |
| L_ERROR_NOACCESS |
Access error. |
| L_ERROR_NOTIMPLEMENTED |
Feature not implemented. |
| L_ERROR_MASTERSOFT |
Text converter filter error. |
| L_ERROR_ABORTED |
The function was aborted. |
| L_ERROR_CONV_NODOCUMENT |
No document in Layout Analyser Storage. |
| L_ERROR_CONV_LECSO |
Layout Analyser command error. |
| L_ERROR_TOO_MANY_SHEETS |
Too many Excel sheets. |
| L_ERROR_DOCFORMATTER |
Internal use only. |
| L_ERROR_STOP |
Internal use only. |
| L_ERROR_VOCALIZER |
Error in Vocalizer Engine. |
| L_ERROR_NO_VOCALIZER_VOICE |
No voice available in Vocalizer Engine. |
| L_ERROR_REALSPEAK |
Error in RealSpeak Solo Engine. |
| L_ERROR_NO_REALSPEAK_VOICE |
No voice available in RealSpeak Engine. |
| L_ERROR_CODEC |
Error in using Codec. |
| L_FATALERRORS |
General OmniPage Document (OPD) Fatal error. |
| L_FERROR_MEMORY |
OmniPage Document (OPD) memory problem. |
| L_FERROR_INTERNAL |
Internal OmniPage Document (OPD) error. |
| L_FERROR_FILEFORMAT |
Wrong file format or wrong reading or writing methods. |
| L_FERROR_INDEX |
Wrong index stream. |
| L_FERROR_RECAPI |
Error in RecApi. |
| L_FERROR_NOSET |
Some attribute was not set. |
| L_FERROR_PERMISSION |
PDF modification restricted. |
| L_FERROR_MISSING |
Missing file (usually a DLL). |
| BRA_INIT_ERR |
Module is no longer supported. |
| MAT_INIT_ERR |
Matrix matching recognition module initialization error. |
| RESERVED_P_INIT_ERR |
Unused recognition module. |
| MTX_INIT_ERR |
MTX recognition module initialization error. |
| FRX_INIT_ERR |
FRX recognition module initialization error. |
| ASN_INIT_ERR |
Asian recognition module initialization error. |
| MNG_INIT_ERR |
MNG recognition module initialization error. |
| STSMN_HANDLE_ERR |
StsMan invalid node handle error. |
| STSMN_NOSETTING_ERR |
No settings in node. |
| STSMN_BADTYPE_ERR |
Improper setting type. |
| STSMN_OPNOTALLOWED_ERR |
Operation not allowed for setting or node. |
| STSMN_PARAMETER_ERR |
Invalid parameter. |
| STSMN_INVALIDFILE_ERR |
Settings file content invalid. |
| STSMN_NOTFOUND_ERR |
Node not found. |
| STSMN_FULLSAVEDTREE_WARN |
The loaded settings file may contain default values. |
| STSMN_BADORMISSINGREF_ERR |
The reference of a symbolic link subtree is invalid or the referenced setting does not exist yet. |
| STSMN_EMPTYPENDVAL_WARN |
Pending setting has no value in the current Settings Collection. |
| STSMN_NOSESSION_ERR |
Storage of settings collections does not exist or too many settings collections are created. |
| IPRO_E_NOTALLOWED |
Operation not allowed. |
| IPRO_E_TOOMANYENGINE |
Only one Engine object can be created. |
| IPRO_E_ENGINEINITFAILED |
Engine not initialized. |
| IPRO_E_IMAGEFILESINITFAILED |
ImageFiles collection cannot be created. |
| IPRO_E_MEMORYBITMAPSINITFAILED |
MemoryBitmaps collection cannot be created. |
| IPRO_E_UDMANAGERINITFAILED |
UDManager object cannot be created. |
| IPRO_E_BARCODETYPESINITFAILED |
BarcodeTypes collection cannot be created. |
| IPRO_E_MODULEINFOSINITFAILED |
ModuleInfos collection cannot be created. |
| IPRO_E_UILANGUAGESINITFAILED |
UILanguages collection cannot be created. |
| IPRO_E_SPELLLANGUAGESINITFAILED |
SpellLanguages collection cannot be created. |
| IPRO_E_DOCUMENTSINITFAILED |
Documents collection cannot be created. |
| IPRO_E_SCANNERSINITFAILED |
Scanners collection cannot be created. |
| IPRO_E_SCANNERINITFAILED |
Scanner not initialized. |
| IPRO_E_CONVERTERSINITFAILED |
Converters collection cannot be created. |
| IPRO_E_SETTINGMANAGERINITFAILED |
SettingManager object cannot be created. |
| IPRO_E_OBJECTISINVALID |
Invalid object: cannot be used. |
| IPRO_E_CONVERTERMANAGERUNKNOWN |
ConverterManager not found. |
| IPRO_E_CONVERTERNOTFOUND |
Converter not found. |
| IPRO_W_ZONEINVALID |
Some zones have incorrect attributes. |
| DOCUMENT_INVALID_ERR |
Corrupt document. |
| DOCUMENT_ACCESS_ERR |
Document access error. |
| DOCUMENT_RDONLY_SAVE_ERR |
Document is read-only. |
| DOCUMENT_CONVERT_ERR |
Document conversion error. |
| DOCUMENT_SHAREVIOLATION_ERR |
Sharing violation. |
| DOCUMENT_NOTEXIST_ERR |
Document does not exist. |
| DOCUMENTMGR_NOTINIT_ERR |
Document Manager is not initialized. |
| DOCUMENT_CANCEL |
Document operation cancelled. |
| DOCUMENT_VERSION_ERR |
Document version error. |
| DOCUMENT_ZOP_ERR |
Zone operation error. |
| DOCUMENT_ZOP_NOTFOUND_ERR |
Zone not found. |
| DOCUMENT_ZOP_BADSHAPE_ERR |
Zone has invalid shape. |
| DOCUMENT_ZOP_NEEDOCR_ERR |
OCR needed. |
| WORKFLOW_START_ERR |
The starting of the active workflow has failed. |
| WORKFLOW_PROCESSED_ERR |
The workflow is already processed. |
| WORKFLOW_INTERACTIVE_ERR |
The workflow step is not in interactive mode. |
| WORKFLOW_INPUT_ERR |
The workflow doesn't need any input file. |
| WORKFLOW_OUTPUT_ERR |
The workflow doesn't need any output file. |
| WORKFLOW_CREATION_ERR |
Workflow creation error. |
| WORKFLOW_INACTIVE_ERR |
The workflow is inactive but the method needs an active one. |
| WORKFLOW_ACTIVE_ERR |
The workflow is active but the method needs an inactive one. |
| WORKFLOW_INVALID_ERR |
The workflow definition is invalid or doesn't exist. |
| WORKFLOW_DOCUMENT_ERR |
The workflow definition doesn't belong to document. |
| WORKFLOW_ITEMNOTFOUND_ERR |
Item not found. |
| WORKFLOW_PARAMNOTFOUND_ERR |
Parameter not found. |
| WORKFLOW_PARAMEXISTS_ERR |
Parameter already exists. |
| WORKFLOW_RECCHARS_INF |
Number of recognized characters: %s. |
| WORKFLOW_RECWORDS_INF |
Number of recognized words: %s. |
| WORKFLOW_RECREJCHARS_INF |
Number of rejected characters: %s. |
| WORKFLOW_LDFAXCORR_INF |
Fax correction: %s. |
| WORKFLOW_LDROT_INF |
Rotation: %s. |
| WORKFLOW_LDSKEW_WARN |
Large image skew. |
| WORKFLOW_BARCODE_INF |
An incoming barcode cover page was detected and the associated workflow was found. |
| WORKFLOW_BARCODE_ERR |
An incoming barcode cover page was detected, but its associated workflow was not found. |
| WORKFLOW_LDPATTERN_WARN |
There are no files with a name that matches the specified pattern. |
| WORKFLOW_HWND_ERR |
Parent window is not defined. |
| WORKFLOW_HWNDCREATE_ERR |
Failed to create window. |
| WORKFLOW_HWND_WARN |
Parent window is not defined. |
| WORKFLOW_RECLANGCONF_WARN |
Language conflict detected. |
| WORKFLOW_ZNMANUAL_INF |
Image was zoned manually. |
| WORKFLOW_ZNTEMPLATE_INF |
Image was template zoned: '%s'. |
| WORKFLOW_IPNOTOOL_ERR |
Enhancement template contains unknown tool. |
| WORKFLOW_IPLOAD_ERR |
Error loading enhancement template file. |
| WORKFLOW_IPTEMPLATE_INF |
Image was enhanced with '%s'. |
| WORKFLOW_IPMANUAL_INF |
Image was enhanced manually. |
| WORKFLOW_IPMANUAL_WARN |
User performed no manual image enhancement. |
| WORKFLOW_EDBLANK_WARN |
Page is blank, not saved. |
| WORKFLOW_EDCONVERT_WARN |
Conversion of one or more images was skipped. |
| WORKFLOW_EDNOFILE_WARN |
Output file was not generated. |
| WORKFLOW_DEPAGERANGE_ERR |
Invalid page range. |
| WORKFLOW_DETEMPLATE_ERR |
Invalid form template file. |
| WORKFLOW_LDPDFCREATE_ERR |
Communication error with the PDF printer driver. |
| WORKFLOW_GOOGLEDOCS_FILETYPE_ERR |
Cannot save this file type to GoogleDocs. |
| WORKFLOW_EVERNOTE_FILETYPE_ERR |
Cannot save this file type to Evernote. |
| WORKFLOW_LDBLANKPAGE_WARN |
Blank page was detected and skipped. |
| WORKFLOW_INTERACTIONSUPRESSED_WARN |
User interaction was suppressed. |
| WORKFLOW_CANCEL_WARN |
User canceled the operation. |
| WORKFLOW_PAGECLASS_WARN |
Page could not be classified. |
| WORKFLOW_PAGECLASS_INF |
Page was classified: %s. |
| LINK_MORESPACE_ERR |
Need a bigger buffer. |
| LINK_CANCEL_WARN |
User canceled the operation. |
| LINK_NOTAUTHORIZED_ERR |
Not authorized to access the server. |
| LINK_NOTFOUND_ERR |
Couldn't find the path. |
| LINK_FILEEXISTS_ERR |
The specified file already exists on the server. |
| LINK_EVERNOTE_BAD_DATA_FORMAT |
The format of the request data was incorrect. |
| LINK_EVERNOTE_PERMISSION_DENIED |
Not permitted to perform action. |
| LINK_EVERNOTE_DATA_REQUIRED |
A required parameter/field was absent. |
| LINK_EVERNOTE_LIMIT_REACHED |
Operation denied due to data size limit. |
| LINK_EVERNOTE_QUOTA_REACHED |
Operation denied due to user storage limit. |
| LINK_EVERNOTE_INVALID_AUTH |
Username and/or password incorrect. |
| LINK_EVERNOTE_AUTH_EXPIRED |
Authentication token expired/revoked. |
| LINK_EVERNOTE_DATA_CONFLICT |
Change denied due to data conflict. |
| LINK_EVERNOTE_ENML_VALIDATION |
Content of submitted note was malformed. |
| LINK_EVERNOTE_SHARD_UNAVAILABLE |
Service shard with account data is temporarily down. |
| LINK_EVERNOTE_TOO_WHATEVER |
Operation denied due to data size limit. |
| LINK_EVERNOTE_UNSUPPORTED_OPERATION |
Operation denied because it is currently unsupported. |
| LINK_EVERNOTE_TAKEN_DOWN |
Operation denied because access to the corresponding object is prohibited in response to a take-down notice. |
| LINK_EVERNOTE_RATE_LIMIT_REACHED |
Operation denied because the calling application has reached the hourly API call limit of the user. |
| LINK_EVERNOTE_BUSINESS_SECURITY_LOGIN_REQUIRED |
Access to a business account has been denied because the user must complete additional steps in order to comply with business security requirements. |
| LINK_EVERNOTE_DEVICE_LIMIT_REACHED |
Operation denied because the maximum allowed number of devices of the user has exceeded. |
| enum RETCODEINFO |
Error code (return code) categories.
The RECERR codes can be grouped into some categories according to their types. These categories can be queried to a specified error code by calling kRecGetErrorInfo.
| RET_OK |
Normal operation (REC_OK) |
| RET_WARNING |
A warning situation (like NO_TXT_WARN or IMF_PASSWORD_WARN etc.) |
| RET_MEMORY_ERROR |
A memory allocation releated error (like FILE_MEM_ERR or MEM_INVALIDPOINTER_ERR etc.) |
| RET_FILE_ERROR |
A file handling error (like FILE_NOTFOUND_ERR or IMF_FILENOTEMPTY_ERR etc.) |
| RET_SCANNER_ERROR |
A scanner related error (like RSD_PAPERJAM or RSD_COVEROPEN etc.) |
| RET_IMAGE_ERROR |
An image problem (like IMG_SIZE_ERR or IMF_NOTSUP_ERR etc.) |
| RET_OCR_ERROR |
A recognition problem (like FRX_INIT_ERR or BAR_INVALID_CODE_ERR etc.) |
| RET_TEXT_ERROR |
A text conversion error (like L_ERROR_TOO_MANY_SHEETS or L_FERROR_PERMISSION etc.) |
| RET_OTHER_ERROR |
Uncategorized error (like CHR_LANG_NOTFOUND_ERR or API_PROCESS_ABORTED_ERR etc.) |
| RET_UNKNOWN |
The return code is unknown. |
| RETCODEINFO RECAPIKRN kRecGetErrorInfo | ( | RECERR | ErrCode, |
| LPCSTR * | lpErrSym | ||
| ) |
Getting additional information about an error.
The kRecGetErrorInfo function retrieves some information about an error code.
| [in] | ErrCode | RECERR error code. |
| [out] | lpErrSym | Pointer of a variable to store a pointer of an internal string. This string is the symbolic representation of the error code. |
| RETCODEINFO | Specifies an error category (no error is RET_OK, warnings are RET_WARNING, while other values mean different error situations like RET_FILE_ERROR, RET_SCANNER_ERROR, RET_IMAGE_ERROR, etc.). |
lpErrSym. The symbolic name is "REC_OK" for REC_OK, "FILE_ERR" for FILE_ERR, etc. This string can be used to do localized error message handling as the symbolic name is version independent. RETCODEINFO kRecGetErrorInfo(RECERR re, out string pErrSym);
| RECERR RECAPIKRN kRecGetErrorUIText | ( | RECERR | ErrCode, |
| LONG | ErrExt, | ||
| LPCTSTR | lpErrStr, | ||
| LPTSTR | lpErrUIText, | ||
| int * | pBuffLen | ||
| ) |
Getting the error text of an error.
The kRecGetErrorUIText function retrieves the error text of an error code in the language specified with kRecSetUILang.
| [in] | ErrCode | RECERR error code. |
| [in] | ErrExt | The value of the extended error code returned by kRecGetLastError |
| [in] | lpErrStr | The value of the additional textual information returned by kRecGetLastError |
| [out] | lpErrUIText | A string buffer to store the error text in current codepage or UTF-16 in Windows or UTF-8 code in Linux and Mac |
| [in,out] | pBuffLen | Pointer to the length of the string buffer. On entering it contains the length of the buffer, on returning it gets the exact length of the full string with the terminating zero. |
| RECERR |
RECERR kRecGetErrorUIText(RECERR errCode, int errExt, string errStr, out string errUIText);
| RECERR RECAPIKRN kRecGetLastError | ( | LONG * | pErrExt, |
| LPTSTR | pErrStr, | ||
| int | buflen | ||
| ) |
Getting last error.
This function provides additional information on the error returned with the previous RecAPI function. This function should be called immediately after any RecAPI API call when the function returned with a value other than REC_OK. Its return code, an extended error code and a supplementary character string may help to identify the problem.
| [out] | pErrExt | Pointer of a variable to store the extended error code. Zero (0) value of extended error means there is no extended error information. This parameter can be NULL. |
| [out] | pErrStr | Pointer of a string buffer to store the supplementary character string with additional textual information about the error. Its empty string value means there is no such information. This parameter can be NULL. |
| [in] | buflen | Length of the string buffer. |
| RECERR | The main error code which is the same as the one returned with the failed function. |
RECERR kRecGetLastError(out int ErrExt, out string ErrStr); // or when pErrExt is NULL in C/C++ RECERR kRecGetLastError(out string ErrStr); // or when pErrStr is NULL in C/C++ RECERR kRecGetLastError(out int ErrExt); // or when both are NULL RECERR kRecGetLastError();
| RECERR RECAPIKRN kRecGetLastErrorEx | ( | LONG * | pErrExt, |
| LPTSTR * | ppErrStr, | ||
| LPTSTR * | ppErrXml | ||
| ) |
Getting last error.
This function provides additional information on the error or errors returned by the previous RecAPI function. kRecGetLastErrorEx is an extension of the kRecGetLastError function. The main difference between the two is that this function can return information about several errors or warnings, not only the first one that occurred at the previous function. This function should be called immediately after any RecAPI API call when the function returned with a value other than REC_OK.
| [out] | pErrExt | Pointer of a variable to store the extended error code of the first error. Zero (0) value of extended error means there is no extended error information. This parameter can be NULL. |
| [out] | ppErrStr | Address of a pointer to a string which is allocated and filled by this function with additional textual information about the error. The string is an empty string if there is no additional information. This parameter can be NULL. |
| [out] | ppErrXml | Address of a pointer to a string which is allocated and filled by this function with XML data for all the errors that happened. The string is an empty string if there are no errors. This parameter can be NULL. |
| RECERR | The main error code which is the same as that one returned with the failed function. |
ppErrStr and ppErrXml must be released using kRecFree. ppErrStr error string also contains the same information as with the kRecGetLastError function, while the ppErrXml string contains an XML element for each error and warning that happened during the previous function call. This function could be more handy than the kRecGetLastError function even when you do not need the XML string because there is no buffer length problem with this function. ppErrXml contains elements in XML format. Its root element is an <errors> tag containing <error/> and <warning/> tags with information about the error (or warning) in different attributes. The usual attributes are as follows:code="number": number is a hexadecimal string containing the RECERR codesym="string": string is the symbolic representation of the RECERR code (e.g. "FILE_OPEN_ERR")ext="number": number is a hexadecimal string containing the extended error code, if anystr="string": string is the supplementary character string with additional textual information about the error or warning, if any <errors>
<file name="filename">
<page filepage="number" pagenum="number">
<error code="number" sym="string"/>
</page>
</file>
</errors>
filepage attribute contains the hexadecimal value of the page number of the file, so it is reset to 1 at each file. The 1 based pagenum attribute contains the global page number (also hexadecimal). kRecProcessPages function, then only a page container element is added for each error with a single pagenum attribute. error element contains the name of the file. RECERR kRecGetLastErrorEx(out string ErrXml);
kRecGetLastError function. | RECKRNDLL LPCSTR RECKRNCALL watch_recerr | ( | RECERR | ErrCode | ) |
Debugging utility function: Getting a string with the symbolic error code.
The watch_recerr function retrieves the symbolic error code of an error.
| [in] | ErrCode | RECERR error code. |
| LPCSTR | A pointer to the error string. |
RECERR variable. This function does not have any side effects, so it can be safely used in Watch expressions. For example, to see a legible code value of the variable rc put the expression watch_recerr(rc)
const char *recerr(RECERR ErrCode) { return watch_recerr(ErrCode); }