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

Sets the background color used to redact match results.

Declaration:

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

Arguments:

Name Type Description
higRecRedactor const HIG_REC_REDACTOR The handle to a redactor instance.
lpColor const AT_RGBQUAD* const The pointer to new fill color value.

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 higRedactor = 0 ;
AT_RGBQUAD white = { 0xFF, 0xFF, 0xFF, 0x00 } ;

IG_REC_redactor_create( &higRedactor ) ;    
errCount = IG_REC_redactor_fillcolor_set 
                          ( higRedactor, 
                            &white
                          ) ;
IG_REC_redactor_delete( higRedactor ) ;

Remarks:

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

The default value is NULL.

If fill color is not specified, then the redactor will default to black, rgb(0,0,0) when drawing rectangles onto the redacted image.

See Also

HIG_REC_REDACTOR