Admin Production ni-theme
Current Publication

GetCtrlArrayBoundingRect

LabWindows/CVI

GetCtrlArrayBoundingRect

int GetCtrlArrayBoundingRect (int controlArrayHandle, int *top, int *left, int *height, int *width);

Purpose

Returns the top, left, width, and height coordinates of the bounding rectangle of all the controls in the control array.

Parameters

Input
Name Type Description
controlArrayHandle int Specifier for a particular control array that is currently in memory. You obtain this handle from GetCtrlArrayFromResourceID or NewCtrlArray.
Output
Name Type Description
top int The top coordinate of the bounding rectangle of all the controls in the control array.

The range of top is –32,768 to 32,767. The origin (0,0) is at the upper left corner of the panel, before the panel is scrolled, directly below the title bar. You can pass NULL for this parameter.
left int The left coordinate of the bounding rectangle of all the controls in the control array.

The range of left is –32,768 to 32,767. The origin (0,0) is at the upper left corner of the panel, before the panel is scrolled, directly below the title bar. You can pass NULL for this parameter.
height int The vertical size of the bounding rectangle of all the controls in the control array.

The range of height is 1 to 32,767. The origin (0,0) is at the upper left corner of the panel, before the panel is scrolled, directly below the title bar.
width int The horizontal size of the bounding rectangle of all the controls in the control array.

The range of width is 1 to 32,767. The origin (0,0) is at the upper left corner of the panel, before the panel is scrolled, directly below the title bar.

Return Value

Name Type Description
status int Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Additional Information

Library: User Interface Library

Include file: userint.h

LabWindows/CVI compatibility: LabWindows/CVI 2010 and later