ImageGear Professional DLL v17.2 for Windows
IG_REC_redactor_progress_cb_get
Send Feedback
ImageGear Professional DLL v17.2 for Windows > API Reference Guide > Recognition Component API Reference > Recognition Component Functions Reference > Redactor Functions > IG_REC_redactor_progress_cb_get

Glossary Item Box

Identifies the redactor progress callback.

Declaration:

  Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_redactor_progress_cb_get(
   const HIG_REC_REDACTOR higRecRedactor,
   LPPFNIG_REC_REDACTOR_PROGRESS_CB const  lppfnCallback,
   LPVOID *const  lppUserData
);

Arguments:

Name Type Description
higRecRedactor const HIG_REC_REDACTOR The handle to a redactor instance.
lppfnCallback LPPFNIG_REC_REDACTOR_PROGRESS_CB The far pointer indicating where to return the progress callback function to invoke during redaction.
lppUserData LPVOID The far pointer indicating where to return the anonymous data passed to the continue 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 ;
LPFNIG_REC_REDACTOR_PROGRESS_CB user_callback = 0;
LPVOID user_data = 0 ;

IG_REC_redactor_create( &higRecRedactor ) ;
errCount = IG_REC_redactor_progress_cb_get 
                          ( higRecRedactor, 
                            &user_callback,
                            &user_data
                          ) ;
IG_REC_redactor_delete( higRecRedactor ) ;

Remarks:

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

See Also

HIG_REC_REDACTOR

©2012. Accusoft Corporation. All Rights Reserved.