PtTreeRemoveChildren()

Unlink the children of the specified item

Synopsis:

PtTreeItem_t *PtTreeRemoveChildren( 
                 PtTreeItem_t *item );

Description:

This function unlinks all the children of the specified item and returns the pointer to the first of them:

The results of using PtTreeRemoveChildren().

You can then give the pointer to the PtTreeFreeItems() function.

This function doesn't collapse the item. If the children are visible, PtTreeRemoveChildren() returns NULL. Call PtTreeCollapse() before PtTreeRemoveItem() to make sure that the item is collapsed.

Returns:

A pointer to the first of the removed children, or NULL if the children are visible.

Classification:

Photon

See also:

PtTree, PtTreeAddAfter(), PtTreeAddFirst(), PtTreeAllocItem(), PtTreeFreeAllItems(), PtTreeFreeItems(), PtTreeItem_t, PtTreeRemoveItem(), PtTreeRemoveList()