GetPanelHandleFromTabPage
int GetPanelHandleFromTabPage (int panelHandle, int controlID, int index, int *tabPanelHandle);
Purpose
Retrieves the panel handle of a tab page in a tab control.
Use the panel handle to specify the panel associated with the tab page in subsequent function calls.
Refer to the InsertTabPage function reference for an example of how to use this and other tab control functions.
Supported Controls
You can use GetPanelHandleFromTabPage with tab controls.
Parameters
| Input | ||
| Name | Type | Description |
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. |
| controlID | int | The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl. |
| index | int | Zero-based index of the tab page whose panel handle will be retrieved. |
| Output | ||
| Name | Type | Description |
| tabPanelHandle | int | Returns the panel handle of the tab page at the specified index of the tab control. |
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 8.0 and later
Examples
Refer to the following examples that use the GetPanelHandleFromTabPage function:
- udp\UDPChat.cws
Open example - userint\events.cws
Open example - userint\TabExample.cws
Open example - userint\tabpanels.cws
Open example