ImageGear for C and C++ on Windows v19.5 - Updated
IG_REC_redactor_progress_cb_set
API Reference Guide > Recognition Component API Reference > Recognition Component Functions Reference > Redactor Functions > IG_REC_redactor_progress_cb_set

Assigns the redactor progress callback.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_redactor_progress_cb_set(
   const HIG_REC_REDACTOR higRecRedactor,
   LPFNIG_REC_REDACTOR_PROGRESS_CB const  lpfnCallback,
   LPVOID const  lpUserData
);

Arguments:

Name Type Description
higRecRedactor const HIG_REC_REDACTOR The handle to a redactor instance.
lpfnCallback LPFNIG_REC_REDACTOR_PROGRESS_CB The progress callback function to invoke during redaction.
lpUserData LPVOID Anonymous data passed to the progress callback function.

Return Value:

The number of ImageGear errors that occurred during this function call. If there are no errors, the return value is IGE_SUCCESS.

Supported Raster Image Formats:

This function does not process image pixels.

Example:

 
Copy Code
AT_ERRCOUNT errCount = 0 ;
HIG_REC_REDACTOR higRecRedactor = 0 ;
AT_INT user_data = 0 ;

IG_REC_redactor_create( &higRecRedactor ) ;
errCount = IG_REC_redactor_progress_cb_set 
                          ( higRecRedactor, 
                            &on_redactor_progress,
                            &user_data
                          ) ;
IG_REC_redactor_delete( higRecRedactor ) ; 

Remarks:

Use this function to install a callback to receive progress notifications prior to completion. The callback presents an opportunity to interrupt the operation.

See Also

HIG_REC_REDACTOR