IG_REC_redactor_fillcolor

Gets the fill color used to redact match results.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_redactor_fillcolor_get( const HIG_REC_REDACTOR higRecRedactor, AT_RGBQUAD* const lpColor, AT_INT* const pnDataSize );

Arguments:

Name	Type	Description
higRecRedactor	const HIG_REC_REDACTOR	The handle to a redactor instance.
lpColor	AT_RGBQUAD* const	Pointer to storage for the fill color value.
pnDataSize	AT_INT* const	Pointer to the variable that on input contains size of buffer specified by lpColor parameter. On output it contains number of bytes copied to lpColor buffer: If fill color is specified for the redactor, then this value is copied into output buffer lpColor and number of bytes copied is placed into pnDataSize. If lpColor is NULL and pnDataSize is not NULL then on output pnDataSize contains the size of AT_RGBQUAD structure. If lpColor is not NULL and pnDataSize is not NULL and no text color is assigned to the redactor then on output pnDataSize contains zero.

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 fill_color = {0} ; AT_INT bytes_written = 0 ; IG_REC_redactor_create( &higRedactor ) ; errCount = IG_REC_redactor_fillcolor_get ( higRedactor, &fill_color, &bytes_written ) ; IG_REC_redactor_delete( higRedactor ) ;

Copy Code

AT_ERRCOUNT errCount = 0 ;
HIG_REC_REDACTOR higRedactor = 0 ;
AT_RGBQUAD fill_color = {0} ;
AT_INT bytes_written = 0 ; 

IG_REC_redactor_create( &higRedactor ) ;
errCount = IG_REC_redactor_fillcolor_get 
                          ( higRedactor, 
                            &fill_color,
                            &bytes_written
                          ) ;
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.