imaqGetWindowZoom

NI Vision for LabWindows/CVI Function

imaqGetWindowZoom

Usage

int imaqGetWindowZoom(int windowNumber, int* xZoom, int* yZoom);

Purpose

Retrieves the current zoom factors for a given image window. The zoom factor indicates an increase or decrease in the magnification of an image. A positive number indicates a magnification by the amount specified. For example, a zoom factor of 3 indicates that the image is displayed at three times its actual size (3:1). A negative number indicates that the image is decreased in magnification by the specified amount. For example, a zoom factor of —5 indicates that the image is displayed at one-fifth its actual size (1:5).

Note   This function is obsolete. The replacement function is imaqGetWindowZoom2().

Parameters

Name

Type

Description

windowNumber int The window number of the image window.
xZoom int* On return, the current zoom factor in the x direction for the window.
yZoom int* On return, the current zoom factor in the y direction for the window.

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