Admin Production ni-theme
Current Publication

SetActiveTabPage

LabWindows/CVI

SetActiveTabPage

int SetActiveTabPage (int panelHandle, int controlID, int index);

Purpose

Sets the active tab page of a tab control and gives the keyboard focus to the tab page.

Use the control attribute ATTR_CTRL_INDEX to set the active tab page without changing the keyboard focus.

Refer to the InsertTabPage function reference for an example of how to use this and other tab control functions.

Supported Controls

You can use SetActiveTabPage 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.

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 SetActiveTabPage function:

  • udp\UDPChat.cws

    Open example
  • userint\TabExample.cws

    Open example