GetActiveTabPage
int GetActiveTabPage (int panelHandle, int controlID, int *activeIndex);
Purpose
Returns the index of the active tab page.
Supported Controls
You can use GetActiveTabPage 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. |
| Output | ||
| Name | Type | Description |
| activeIndex | int |
The zero-based index of the active tab page. –1 if the tab control has no tab pages. |
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
Example
Refer to udp\UDPChat.cws for an example of using the GetActiveTabPage function.