int GetTreeItemPathLength (int panelHandle, int controlID, int itemIndex, char separator[], int *length);
Returns the length, in bytes, of the path of the specified tree item.
The length returned does not include the terminating NUL byte.
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.
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 |
length | int (passed by reference) | The length, in bytes, of the path of the specified tree item. |
Name | Type | Description | ||||
status | integer | Return value indicating whether the function was successful. A negative number indicates that an error occurred.
|