imaqGetWindowHandle

NI Vision for LabWindows/CVI Function

imaqGetWindowHandle

Usage

int imaqGetWindowHandle(int* handle);

Purpose

Returns an unused window number. You can use the window number in conjunction with functions such as imaqDisplayImage(). This function does not reserve the window number until you call a function that uses the window number.

Parameters

Name

Type

Description

handle int* On return, an unused window number. If no unused window numbers are available, the function sets this parameter to –1. This parameter is required and cannot be NULL.

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