ImageGear Professional DLL v17.1 for Windows Accusoft
IG_REC_redactor_textcolor_set
Send Feedback  
ImageGear Professional DLL v17.1 for Windows > API Reference Guide > Recognition Component API Reference > Recognition Component Functions Reference > Redactor Functions > IG_REC_redactor_textcolor_set

Glossary Item Box

Sets the text color used to redact match results.

Declaration:

  Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_redactor_textcolor_set(
   const HIG_REC_REDACTOR higRecRedactor,
   const AT_RGBQUAD *const  lpColor
);

Arguments:

higRecRedactor The handle to a redactor instance.
lpColor The pointer to new text color value. If lpColor is NULL then text will not be drawn.

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.

Remarks:

This color is used when filling areas of the source image.

The default value is NULL.

If text color is NULL, then the redactor will not draw the replacement text onto the redacted image.

Example:

  Copy Code
AT_ERRCOUNT errCount = 0 ;
HIG_REC_REDACTOR higRedactor = 0 ;
AT_RGBQUAD fuscia = { 0xFF, 0x00, 0xFF, 0x00 } ;

IG_REC_redactor_create( &higRedactor ) ;
errCount = IG_REC_redactor_textcolor_set 
                          ( higRedactor, 
                            &fuscia
                          ) ;
IG_REC_redactor_delete( higRedactor ) ;

See Also

HIG_REC_REDACTOR

©2012. Accusoft Corporation. All Rights Reserved.