imaqSetWindowOverlay

NI Vision for LabWindows/CVI Function

imaqSetWindowOverlay

Usage

int imaqSetWindowOverlay(int windowNumber, const Overlay* overlay);

Purpose

Sets or removes the overlay from a window. This function is obsolete. Overlays are now applied to images, not windows. See the Overlay functions for more information.

Note  This function is obsolete. Overlays are now applied to images, rather than windows. Refer to the Overlay functions topic for more information.

Parameters

Name

Type

Description

windowNumber int The window number of the image window.
overlay const Overlay* The overlay. Set this parameter to NULL to remove any existing overlay from the given 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().