PtGenTreeRemoveChildren()

Unlink all the children of a given item

Synopsis:

PtGenTreeItem_t *PtGenTreeRemoveChildren( 
                     PtGenTreeItem_t *item );

Description:

This function unlinks all the children of the given item and returns the pointer to the first of them. You can then give the pointer to PtGenTreeFreeItems().

This function doesn't collapse the item. If the children are visible, NULL is returned. Call PtGenTreeCollapse() before PtGenTreeRemoveItem() to make sure the item is collapsed.

Returns:

A pointer to the first unlinked child.

Classification:

Photon