GetTreeItemPath
int GetTreeItemPath (int panelHandle, int controlID, int itemIndex, char separator[], char path[]);
Purpose
Returns the path of the specified tree item.
The path of an item consists of the labels of its ancestors concatenated together, starting at level zero. The labels are separated by the separator string.
Supported Controls
You can use GetTreeItemPath 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. |
| itemIndex | int | Zero-based index of the tree item. |
| separator | char [] | The string used to separate the labels of each ancestor item. |
| Output | ||
| Name | Type | Description |
| path | char [] | Buffer into which the path of the specified tree item is stored. The number of bytes in this buffer must be at least one byte greater than the value returned by GetTreeItemPathLength for this tree item. |
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