util/src/TclTk/blt2.5/html/Blt_TreeNodeId.html

   1
   2                                    <!-- manual page source format generated by PolyglotMan v3.0.9, -->
   3 <!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
   4
   5 <HTML>
   6 <HEAD>
   7 <TITLE>Blt_TreeNodeId(3) manual page</TITLE>
   8 </HEAD>
   9 <BODY bgcolor=white>
  10 <A HREF="#toc">Table of Contents</A><P>
  11
  12 <H2><A NAME="sect0" HREF="#toc0">Name</A></H2>
  13 Blt_TreeNodeId - Returns the node
  14 serial number.
  15 <H2><A NAME="sect1" HREF="#toc1">Synopsis</A></H2>
  16 <BR>
  17 <PRE>#include &lt;bltTree.h&gt;
  18
  19 unsigned int
  20 Blt_TreeNodeId(node)
  21 </PRE>
  22 <H2><A NAME="sect2" HREF="#toc2">Arguments</A></H2>
  23 <P>
  24 Blt_TreeNode   <I>node</I><tt> </tt>&nbsp;<tt> </tt>&nbsp;(in)<BR>
  25 <tt> </tt>&nbsp;<tt> </tt>&nbsp;Node whose ID is to be returned.
  26 <H2><A NAME="sect3" HREF="#toc3">Description</A></H2>
  27 This procedure returns the
  28 node serial number.  The node serial number is useful for programs that
  29 export the tree data object to the Tcl programming level.  Since node labels
  30 (and therefore pathnames) are not unique, the ID can be used to uniquely
  31 identify a node.   <P>
  32 The arguments are as follows:
  33 <DL>
  34
  35 <DT><I>node</I> </DT>
  36 <DD>The node whose serial
  37 number is returned.  The serial number of  the root node for example is
  38 always 0. </DD>
  39 </DL>
  40
  41 <H2><A NAME="sect4" HREF="#toc4">Returns</A></H2>
  42 The serial number of the node.  Nodes are given a unique
  43 serial number when they are created.  You can use the ID to later retrieve
  44 the node using <B>Blt_TreeGetNode</B>.
  45 <H2><A NAME="sect5" HREF="#toc5">Example</A></H2>
  46 The following example prints the
  47 ID of a node.  <BR>
  48 <CODE>printf("root ID is %s\n", <A HREF="Blt_TreeNodeId.node">Blt_TreeNodeId(node)</A>
  49 );<BR>
  50
  51 <H2><A NAME="sect6" HREF="#toc6"></CODE>Keywords</A></H2>
  52 Tcl_TreeCreateNode, Tcl_TreeDeleteNode <P>
  53
  54 <HR><P>
  55 <A NAME="toc"><B>Table of Contents</B></A><P>
  56 <UL>
  57 <LI><A NAME="toc0" HREF="#sect0">Name</A></LI>
  58 <LI><A NAME="toc1" HREF="#sect1">Synopsis</A></LI>
  59 <LI><A NAME="toc2" HREF="#sect2">Arguments</A></LI>
  60 <LI><A NAME="toc3" HREF="#sect3">Description</A></LI>
  61 <LI><A NAME="toc4" HREF="#sect4">Returns</A></LI>
  62 <LI><A NAME="toc5" HREF="#sect5">Example</A></LI>
  63 <LI><A NAME="toc6" HREF="#sect6">Keywords</A></LI>
  64 </UL>
  65 </BODY></HTML>