Admin Production ni-theme
Current Publication

GetTreeItemFromTag

LabWindows/CVI

GetTreeItemFromTag

int GetTreeItemFromTag (int panelHandle, int controlID, char tag[], int *item);

Purpose

Searches for the item with the specified tag.

Returns in the item parameter the index of the item that has the specified tag.

Supported Controls

You can use GetTreeItemFromTag with tree 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.
tag char [] The tag to search for among the tree items.
Output
Name Type Description
item int The index of the item that has the specified tag.

–1 indicates that no item has the specified tag.

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 7.0 and later