Blt_TreeNodeId(3)

Blt_TreeNodeId3

Returns the node serial number.

Usage

#include <bltTree.h>

unsigned int
Blt_TreeNodeId(node)

    


    

Arguments

Blt_TreeNode node (in)

Node whose ID is to be returned.


    


            

Overview

This procedure returns the node serial number. The node serial number is useful for programs that export the tree data object to the Tcl programming level. Since node labels (and therefore pathnames) are not unique, the ID can be used to uniquely identify a node.

The arguments are as follows:

node

The node whose serial number is returned. The serial number of the root node for example is always 0.

Returns

The serial number of the node. Nodes are given a unique serial number when they are created. You can use the ID to later retrieve the node using Blt_TreeGetNode.

Examples

The following example prints the ID of a node.

printf("root ID is %s\n", Blt_TreeNodeId(node));

Keywords

Tcl_TreeCreateNode, Tcl_TreeDeleteNode

Releases

11 releases since Debian 3.1 (Sarge); the text changed 1 time.

  1. 3.1–7
  2. 8–13

From blt-dev 2.5.3+dfsg-8 in Debian 13 (Trixie). Parsed by carta from the page's man source.