IMAQ WindGrid VI

LabView NI Vision

IMAQ WindGrid VI

Owning Palette: External DisplayInstalled With: NI Vision Development Module

Obtains or modifies the status of the grid. If enabled, the grid is invisible and drawn ROIs will be constrained to it. The grid can be used to help trace a region of interest accurately.

Note  This VI is not supported on ETS targets or VxWorks targets.

IMAQ WindGrid

cnclst.gif

Grid Size is the new size of the grid if Get/Set Status (Set) is TRUE. Otherwise, the VI ignores this input.

ci32.gif

X Offset specifies the horizontal offset of the grid.

ci32.gif

Y Offset specifies the vertical offset of the grid.

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 to retrieve (Get) or modify (Set) the step values for the grid. The default is TRUE (Set).

inclst.gif

Grid Size out returns the present grid size.

ii32.gif

X Offset indicates the horizontal offset of the grid.

ii32.gif

Y Offset Indicates the vertical offset of the grid.

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.