imaqSetupToolWindow

NI Vision for LabWindows/CVI Function

imaqSetupToolWindow

Usage

int imaqSetupToolWindow(int showCoordinates, int maxIconsPerLine, const ToolWindowOptions* options);

Purpose

Configures the appearance and availability of the tools in the tool window.

Parameters

Name

Type

Description

showCoordinates int Determines whether active pixel coordinates are visible. Set this parameter to TRUE to display the active pixel coordinates. Set this parameter to FALSE if you do not want the coordinates to show.
maxIconsPerLine int The maximum number of tool icons to show on each line. The tool window uses the minimum number of lines needed to display all of the tools based on this parameter and distributes the tools as evenly as possible.
options const ToolWindowOptions* Determines the availability of tools in the tool window. Set options to NULL to display all the tools.

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