FNIG_REC_PROGRESS

The user-written progress monitoring callback function.

Declaration:

	Copy Code
enumIGRecError ACCUAPI FNIG_REC_PROGRESS_MONITOR( LPAT_REC_PROGRESS_MONITOR mod, LPAT_VOID lpUserData );

Arguments:

Name	Type	Description
mod	LPAT_REC_PROGRESS_MONITOR	This variable holds the current state of the activated action (ProcessID, progress information etc).
lpUserData	LPAT_VOID	User data passed to the callback function by the Engine. The data to be passed can be set with IG_REC_progress_CB_register.

Return Value:

IGE_REC_EXT_API_PROCESS_ABORTED_ERR if the user has requested the current processing to be aborted; processing will stop at the first suitable moment.
IGE_REC_EXT_OK if the process can be continued normally.

Supported Raster Image Formats:

See IG_REC_image_import.

Remarks:

This user-written callback procedure for progress monitoring must be registered by the IG_REC_progress_CB_register function. The Engine will continually invoke this registered callback procedure during different workflow processes (enumIGRecProcessId), providing a pointer to a AT_REC_PROGRESS_MONITOR structure that contains the current processing stage and a percentage indicator value. The application can provide progress indication for this procedure.

Enabling progress monitoring in the integrating application during the recognition process might cause a significant speed decrease, especially for zones on small images when they are recognized with the recognition module enumIGRecRecognitionModule.IG_REC_RM_OMNIFONT_MTX.