RECOGNIZESTATUSCALLBACK Function

#include "ltdoc.h"

L_INT pEXT_CALLBACK YourFunction(nRecogPage, nError, pUserData)

L_INT nRecogPage;	/* recognized page index */
L_INT nError;	/* error code for the last recognized page */
L_VOID * pUserData;	/* pointer to additional parameters */

Reports the recognized page status.

Parameter	Description
nRecogPage	Specifies the index for the recognized page. This index is zero-based.
nError	Specifies the error that will be returned from the recognition process.
pUserData	A void pointer that you can use to access a variable or structure containing data that your callback function needs. This gives you a way to receive data indirectly from the function that uses this callback function. (This is the same pointer that you pass in the pUserData parameter of L_DocRecognize function.)
	Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This callback will be invoked after recognizing each page. It will report the recognized page index with the error code (status) that was returned from the recognition process.

This callback will be invoked by a call to L_DocRecognize.

If this callback function return an error code < SUCCESS, the recognition process will be terminated, and no more pages will be processed.

Return SUCCESS from this callback to continue the recognition process.

Required DLLs and Libraries

LTDOC

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:	L_DocGetStatus, L_DocSaveResultsToMemory, L_DocFreeMemoryResults, L_DocSetRecognitionResultOptions, L_DocGetRecognitionResultOptions, L_DocEnumOutputFileFormats, L_DocGetTextFormatInfo, L_DocSaveResultsToFile, L_DocSetSpecialChar, L_DocGetSpecialChar, L_DocGetRecognizedCharacters, L_DocSetRecognizedCharacters, L_DocFreeRecognizedCharacters, L_DocRecognize
Topics:	Recognizing Document Pages
	OCR Functions: Callbacks

Example

For an Example, refer to L_DocRecognize.