imaqGetWindowGrid

Usage

int imaqGetWindowGrid(int windowNumber, int* xResolution, int* yResolution);

Purpose

Retrieves the grid resolution of the image window. Grid resolution is the number of pixels between grid lines. NI Vision uses the grid resolution when drawing regions of interest on the window using tools in the tool window. You can use the grid to trace a region of interest accurately.

Parameters

Name	Type	Description
windowNumber	int	The window number of the image window.
xResolution	int*	On return, the number of pixels between grid lines in the x direction. Set this parameter to NULL if you do not need this information.
yResolution	int*	On return, the number of pixels between grid lines in the y direction. 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().