GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  BLT_TREEDELETENODE (3)

NAME

Blt_TreeDeleteNode - Deletes a node and its descendants.

CONTENTS

Synopsis
Arguments
Description
Returns
Example
Notifications
Keywords

SYNOPSIS

#include <bltTree.h>

Blt_TreeNode Blt_TreeDeleteNode(tree, node)

ARGUMENTS


.TP 15 Blt_Tree  tree(in)
Blt_Tree  tree Blt_Tree Tree containing the node.
.TP 15 Blt_TreeNodenode(in)
Blt_TreeNodenode Blt_TreeNode Node to be deleted.

   








\L’|0u-1v’\l’75u+3n_’\L’0u+1v-0u’\l’|0u-1.5n_’



\L’|0u-1v’\L’0u+1v-0u’\l’|0u-1.5n_’





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 reference count of the Tcl_Obj is decremented.
Since all tree objects must contain at least a root node, the root node itself 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
Search for    or go to Top of page |  Section 3 |  Main Index


BLT BLT_TREEDELETENODE (3) 2.5

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.