FreeBSD Manual Pages
Blt_TreeDeleteNode(3) BLT Library Procedures Blt_TreeDeleteNode(3) ________________________________________________________________________________ NAME Blt_TreeDeleteNode - Deletes a node and its descendants. SYNOPSIS #include <bltTree.h> Blt_TreeNode Blt_TreeDeleteNode(tree, node) ARGUMENTS Blt_Tree tree (in) Tree containing the node. Blt_TreeNode node (in) Node to be deleted. _________________________________________________________________ DESCRIPTION This procedure deletes a given node and all it descendants from a tree data object. The arguments are as follows: tree The tree containing the parent node. node Node to be deleted. The node and its descendant nodes are deleted. Each node's data values are deleted also. The refer- ence count of the Tcl_Obj is decremented. Since all tree objects must contain at least a root node, the root node it- self can't be deleted unless the tree is released and destroyed. Therefore you can clear a tree by deleting its root, but the root node will remain until the tree is destroyed. RETURNS Always returns TCL_OK. Errors generated in a notification callbacks are backgrounded (see Tcl_TreeCreateNotifyHandler). EXAMPLE The following example deletes the root node. Blt_TreeNode root; root = Blt_TreeRootNode(token); Blt_TreeDeleteNode(token, root); NOTIFICATIONS Blt_TreeDeleteNode can trigger tree notify events. You can be notified whenever a node is deleted by using the Blt_TreeCreateNotifyHandler. A callback routine is registered that will be automatically invoked whenever a node is deleted via Blt_TreeDeleteNode to the tree. KEYWORDS tree, token BLT 2.5 Blt_TreeDeleteNode(3)
NAME | SYNOPSIS | ARGUMENTS | DESCRIPTION | RETURNS | EXAMPLE | NOTIFICATIONS | KEYWORDS
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=Blt_TreeDeleteNode&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>