IMAQ WindBackground VI

LabView NI Vision

IMAQ WindBackground VI

Owning Palette: External DisplayInstalled With: NI Vision Development Module

Allows you to change the way the background of an image window is displayed.

IMAQ WindBackground

ci32.gif

Window Number (0...15) selects the window to configure. The default is 0.

cnclst.gif

Background Options are the options used to configure the window if Get/Set Status? is TRUE. This parameter is ignored if Get/Set Status? is False. The following table describes which parameters are valid for each Fill Style option:

Fill Style Hatch Style Fill Color Background Color
Default
Solid ×
Hatch × × ×
ci32.gif

Fill Style specifies the color used to fill the image window. The following are valid values:

Default (0)

uses the default NI Vision background.

Solid (1)

specifies a solid background for the window.

Hatch (2)

specifies a hatch pattern background for the window.

ci32.gif

Hatch Style specifies the background color of the image window. The following values are valid:

Horizontal (0)

specifies that the background of the display window will be horizontal bars.

Vertical (1)

specifies that the background of the display window will be vertical bars.

Forward Diagonal (2)

specifies that the background of the display window will be diagonal bars. The bars start in the lower-left corner and end in the upper-right corner of the window.

Backward Diagonal (3)

specifies that the background of the display window will be diagonal bars. The bars start in the upper-left corner and end in the lower-right corner of the window.

Cross (4)

specifies that the background of the display window will be intersecting horizontal and vertical bars.

Cross Hatch (5)

specifies that the background of the display window will be intersecting forward and backward diagonal bars.

cu32.gif

Fill Color specifies the color used to fill the image window.

cu32.gif

Background Color specifies the background color of the image window.

cerrcodeclst.gif

error in (no error) describes the error status before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.

cbool.gif

status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.

ci32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

cstr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

cbool.gif

Get/Set Status? (Set) specifies whether you want to get or set the flattening options. The default value is TRUE (Set).

inclst.gif

Background Options Out returns the current background options for the specified window.

ii32.gif

Fill Style returns the type of fill selected for the specified window.

ii32.gif

Hatch Style is the pattern of the background.

iu32.gif

Fill Color is the color used to fill the image window.

iu32.gif

Background Color is the background color of the image window.

ierrcodeclst.gif

error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.

ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

ii32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

istr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.