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.

Parameters

Input
Name Type Description
panelHandle integer Specifier for a particular panel that is currently in memory. You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.
controlID integer 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 NewCtrl or DuplicateCtrl.
itemIndex integer Zero-based index of the tree item.
separator string The string used to separate the labels of each ancestor item.
Output
Name Type Description
path string 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 integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success