File: Blt_TreeName.man3

package info (click to toggle)
blt 2.5.3%2Bdfsg-8
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 24,980 kB
  • sloc: ansic: 133,725; tcl: 17,680; sh: 2,722; makefile: 813; cpp: 370
file content (60 lines) | stat: -rw-r--r-- 2,079 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
'\"
'\" Copyright 1991-1998 by Bell Labs Innovations for Lucent Technologies.
'\"
'\" Permission to use, copy, modify, and distribute this software and its
'\" documentation for any purpose and without fee is hereby granted, provided
'\" that the above copyright notice appear in all copies and that both that the
'\" copyright notice and warranty disclaimer appear in supporting documentation,
'\" and that the names of Lucent Technologies any of their entities not be used
'\" in advertising or publicity pertaining to distribution of the software
'\" without specific, written prior permission.
'\"
'\" Lucent Technologies disclaims all warranties with regard to this software,
'\" including all implied warranties of merchantability and fitness.  In no event
'\" shall Lucent Technologies be liable for any special, indirect or
'\" consequential damages or any damages whatsoever resulting from loss of use,
'\" data or profits, whether in an action of contract, negligence or other
'\" tortuous action, arising out of or in connection with the use or performance
'\" of this software.  
'\"
'\"
.so man.macros
.TH Blt_TreeName 3 BLT_VERSION BLT "BLT Library Procedures"
.BS
.SH NAME
Blt_TreeName \- Returns the name of the tree data object.
.SH SYNOPSIS
.nf
\fB#include <bltTree.h>\fR
.sp
char *
\fBBlt_TreeName\fR(\fItree\fR)
.fi
.SH ARGUMENTS
.AS Blt_Tree tree 
.AP Blt_Tree tree in
Token for the tree object. 
.BE
.SH DESCRIPTION
.PP
This procedure returns the name of the C-based tree data object.
The arguments are as follows:
.TP 1i
\fItree\fR
Token for the tree object.  The token must have been previously 
obtained via \fBBlt_TreeGetToken\fR or \fBBlt_TreeCreate\fR.
.SH RETURNS
The name of the tree object is returned.  The name will be fully
qualified with a namespace context.
.SH EXAMPLE
The following example prints the name of the new tree. 
.CS
Blt_Tree token;

if (Blt_TreeCreate(interp, NULL, &token) != TCL_OK) {
    return TCL_ERROR;
}
printf("tree is %s\\n", Blt_TreeName(token));
.CE
.SH KEYWORDS
Tcl_TreeGetToken, Tcl_TreeExists, Tcl_TreeReleaseToken