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

Sets the replacement text.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_redactor_replacement_text_set(
   const HIG_REC_REDACTOR higRecRedactor,
   const AT_WCHAR replacement_text
);

Arguments:

Name Type Description
higRecRedactor const HIG_REC_REDACTOR The handle to a redactor instance.
replacement_text const AT_WCHAR The new replacement text.

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 ;

IG_REC_redactor_create( &higRecRedactor ) ;
errCount = IG_REC_redactor_replacement_text_set 
                          ( higRecRedactor, 
                            L'*'
                          ) ;
IG_REC_redactor_delete( higRecRedactor ) ; 

Remarks:

Default value is vertical bar ("|", U+007C).

See Also

HIG_REC_REDACTOR