PROGRESSCALLBACK Function

Show in webframe

#include "ltdoc.h"

L_BOOL pEXT_CALLBACK YourFunction(pProgressData, pUserData)

pPROGRESSDATA pProgressData;	/* pointer to PROGRESSDATA structure */
L_VOID * pUserData;	/* pointer to additional parameters */

Reports the progress of a specific operation and offers the client an opportunity to cancel. The address of this callback is passed as an argument to L_DocSetProgressCB.

Parameter	Description
pProgressData	Pointer to a PROGRESSDATA structure that contains progress data for the current 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_DocSetProgressCB.)
	Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function.

Returns

TRUE	The function was successful. Continue processing.
FALSE	An error occurred or the user cancelled.

Comments

This function is called periodically by the OCR engine.

To activate the progress callback function, call L_DocSetProgressCB.

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.

Functions:	L_DocSetProgressCB.
Topics:	Starting and Shutting Down the Engine
	OCR Functions: Callbacks