Toolbar_GetAreaOnPanel
- Updated2023-02-21
- 1 minute(s) read
int Toolbar_GetAreaOnPanel (int panel, Rect *area);
Purpose
Fills out a Rect indicating the area occupied by toolbars docked on the specified panel.
This area can be used to adjust the position of other controls on the panel. This function can be used well in conjunction with the TOOLBAR_EVENT_ARRANGE event.
Parameters
| Input | ||
| Name | Type | Description |
| panel | int | The handle of the panel whose toolbar area will be computed. |
| Output | ||
| Name | Type | Description |
| area | Rect | Set to the smallest area which contains all toolbars docked to the specified panel. |
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: Toolbar
Include file: custctrl\toolbar.h
LabWindows/CVI compatibility: LabWindows/CVI 8.0 and later
Example
Refer to userint\custctrl\toolbar\tooldemo.cws for an example of using the Toolbar_GetAreaOnPanel function.