The methods of the IPTTreeIterator interface are listed below. For a complete list of IPTTreeIterator interface members, see the IPTTreeIterator Members topic.
![]() | Returns information about the children of the current location. Return value is a 2D array. The columns are described by PT_TREE_ITERATOR_CHILD_INFO. There is one row per child item. |
![]() | Retrieve information about the current location. The return value is a 2D array with one row. The columns are identified by PT_TREE_ITERATOR_CHILD_INFO. Conceptually, this function should return the same data as that returned by calling MoveToParent, then calling Children, and picking out the row that represents the current child. |
![]() | Is this iterator at root? |
![]() | Returns the number of children (both nodes and containers) of the current location. Returns -1 if it can't be known without retrieving the children. |
![]() | Retrieve the identifier of the current location |
![]() | Returns the current display style, from PT_TREE_ITERATOR_STYLES. The style determines the format of strings returned by the tree iterator. Defaults to PT_TREE_ITERATOR_STYLE_HTML. |
![]() | Each iterator implmentation requires it's own type of initialization information. This function is a hook to pass in that information, but the format of the argument is not specified- it is implementation specific. |
![]() | Move to a specified location in the tree. The location identifier is a value returned in the PT_TREE_ITERATOR_CHILD_INFO_IDENTIFIER column of the result of a call to Children, or through a call to GetLocation. |
![]() | Move "up" one position in the tree, to the parent of the current node |
![]() | Move to the root of the tree |
![]() | Sets the current display style, to a value from PT_TREE_ITERATOR_STYLES. The style determines the format of strings returned by the tree iterator. Defaults to PT_TREE_ITERATOR_STYLE_HTML. |
IPTTreeIterator Interface | com.plumtree.server.treeiterator Namespace