EasyTab_GetBounds

Download PDF

Updated2023-02-21
2 minute(s) read

int EasyTab_GetBounds (int panel, int tabControl, int whichBounds, Rect *bounds);

Purpose

Note This function is deprecated. National Instruments recommends that you use the tab control instead.

This function gets the size and location of a Tab control.

Parameters

Input
Name	Type	Description
panel	int	The specifier for a particular panel that is currently in memory. This handle will have been returned by the LoadPanel, NewPanel, or DuplicatePanel function.
tabControl	int	The ID returned by the EasyTab_Create or EasyTab_ConvertFromCanvas function.
whichBounds	int	Specifies whether to retrieve the size and position of the interior panel area, excluding the tabs and frame, or the entire control, including the tabs and the frame. If VAL_EASY_TAB_INTERIOR_BOUNDS is specified, the size and position of the panel area (excluding the tabs and frame) is returned. If VAL_EASY_TAB_EXTERIOR_BOUNDS is specified, the size and position of the tab control exterior bounding rectangle (including the tabs and frame) is returned.
Output
Name	Type	Description
bounds	Rect	The Rect structure that is set to the location and size of the Tab control. The Rect structure is defined (in userint.h) as follows: typedef struct { int top; int left; int height; int width; } Rect;

Return Value

Name Type Description

status

int

Return value indicating whether the function was successful. A negative number indicates that an error occurred.

The possible negative error codes are:

Return Values:	0 Success
–1 to –999	A User Interface Library error code. (constants are available in userint.h)
–5000 to –5499	A Toolbox instrument driver error code. (Constants are available in toolbox.h.)

A description of any of these error codes can be obtained using the GetGeneralErrorString function in the toolbox.fp instrument driver.

Additional Information

Library: Easy Tab Control

Include file: custctrl\easytab.h

LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later