imaqSetWindowBackground

NI Vision for LabWindows/CVI Function

imaqSetWindowBackground

Usage

int imaqSetWindowBackground(int windowNumber, WindowBackgroundFillStyle fillStyle, WindowBackgroundHatchStyle hatchStyle, const RGBValue* fillColor, const RGBValue* backgroundColor);

Purpose

Sets the background style and color information for the display window.

Parameters

Name

Type

Description

windowNumber int The window number of the image window.
fillStyle WindowBackgroundFillStyle The fill style of the display window.
hatchStyle WindowBackgroundHatchStyle The hatch style of the display window.
fillColor const RGBValue* The fill color of the display window. Set this parameter to NULL to use the current fill color.
backgroundColor const RGBValue* The background color of the display window. Set this parameter to NULL to use the current background color.

Return Value

Type

Description

int On success, this function returns a non-zero value. On failure, this function returns 0. To get extended error information, call imaqGetLastError().