Handle BatchAPI Return Values - OCR for AnyDoc - Foundation 23.1 - Foundation 23.1 - AnyDoc - external

OCR for AnyDoc Programming Reference Guide

Platform
AnyDoc
Product
OCR for AnyDoc
Release
Foundation 23.1
License

Each BatchAPI function returns an integer value indicating the result of the operation.

A successful operation returns, OCRFF_SUCCESS (1). A return value of OCRFF_NO_WORK (31) also indicates a successful operation. However no work was completed.

Any other return values indicate a failure. A return value of OCRFF_ERROR (32) indicates the OCR for AnyDoc transaction aborted.

ASCII Translations for these error codes are obtained by using the function OCRFFAPI_Error2String().

Error

Text

0

Unknown error.

1

Successful operation.

2

OCRFFAPI_Connect() failed.

3

Import override directory does not exist.

4

OCR for AnyDoc is not running. Call OCRFFAPI_Connect.

5

Batch process is already in progress.

 

Batch process requires a window handle or file name.

 

Error opening output file.

 

A form family is required.

6

Structure pointer is invalid.

7

No batch process is specified.

8

No form families available.

12

Must call GetFirstFormFamily()/GetFirstBatch() first.

13

A batch ID is required.

14

A valid action is required.

15

Cannot communicate with OCR for AnyDoc.

16

Image action requires image name or sequence.

17

Invalid directory.

31

No work to do for batch process.

32

OCR for AnyDoc transaction aborted.