imaqGetWindowBackground

NI Vision for LabWindows/CVI Function

imaqGetWindowBackground

Usage

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

Purpose

Retrieves 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* On return, the fill style of the display window. Set this parameter to NULL if you do not need this information.
hatchStyle WindowBackgroundHatchStyle* On return, the hatch style of the display window. Set this parameter to NULL if you do not need this information.
fillColor RGBValue* On return, the fill color of the display window. Set this parameter to NULL if you do not need this information.
backgroundColor RGBValue* On return, the background color of the display window. Set this parameter to NULL if you do not need this information.

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().