Admin Production ni-theme
Current Publication

MoveTabPage

LabWindows/CVI

MoveTabPage

int MoveTabPage (int panelHandle, int controlID, int index, int destinationIndex);

Purpose

Moves a tab page to another position in the tab control. The new position is defined by the destination index.

Moving a tab page changes the indices of the existing tab pages between the original index and the final index of the tab page to be moved.

The function returns the new index of the moved tab page or an error.

Supported Controls

You can use MoveTabPage 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 to move.
destinationIndex int Identifies the new position of the tab page to be moved. Pass –1 to move the tab page to the end of the list.

Return Value

Name Type Description
movedToIndex int Returns the index of the moved tab page. Use the index to specify the tab page in subsequent function calls. Negative values indicate that an error occurred.

Additional Information

Library: User Interface Library

Include file: userint.h

LabWindows/CVI compatibility: LabWindows/CVI 8.0 and later