Return to Tcl_GetVar.man CVS log

Up to [Research Unix] / researchv10no / cmd / worm / scsi / tcl

Annotation of researchv10no/cmd/worm/scsi/tcl/Tcl_GetVar.man, revision 1.1.1.1

1.1       root        1: '\" Copyright 1989 Regents of the University of California
                      2: '\" Permission to use, copy, modify, and distribute this
                      3: '\" documentation for any purpose and without fee is hereby
                      4: '\" granted, provided that this notice appears in all copies.
                      5: '\" The University of California makes no representations about
                      6: '\" the suitability of this material for any purpose.  It is
                      7: '\" provided "as is" without express or implied warranty.
                      8: '\" 
                      9: '\" $Header: /sprite/src/lib/tcl/RCS/Tcl_GetVar.man,v 1.3 90/03/11 17:22:41 ouster Exp $ SPRITE (Berkeley)
                     10: '\" 
                     11: .so \*(]ltmac.sprite
                     12: .HS Tcl_GetVar tcl
                     13: .BS
                     14: .SH NAME
                     15: Tcl_GetVar \- return the value of a Tcl variable
                     16: .SH SYNOPSIS
                     17: .nf
                     18: \fB#include <tcl.h>\fR
                     19: .sp
                     20: char *
                     21: \fBTcl_GetVar\fR(\fIinterp, varName, global\fR)
                     22: .SH ARGUMENTS
                     23: .AS Tcl_Interp *interp
                     24: .AP Tcl_Interp *interp in
                     25: Interpreter in which to check for variable.
                     26: .AP char *varName in
                     27: Name of desired variable.
                     28: .AP int global in
                     29: If non-zero, then insist that \fIvarName\fR be interpreted as
                     30: a global variable regardless of whether a procedure invocation
                     31: is in progress.
                     32: .BE
                     33: 
                     34: .SH DESCRIPTION
                     35: .PP
                     36: \fBTcl_GetVar\fR is a utility procedure used by several of the Tcl commands.
                     37: It returns the value of variable \fIvarName\fR in
                     38: interpreter \fIinterp\fR.  If there isn't a Tcl command procedure
                     39: being interpreted right now, or if \fIglobal\fR is non-zero,
                     40: then \fIvarName\fR is always treated
                     41: as the name of a global variable.  Otherwise, if a procedure is
                     42: being interpreted,
                     43: then \fIvarName\fR will be treated as a local variable name, unless
                     44: it has been declared global using the \fBglobal\fR command.  If
                     45: no variable by the name \fIvarName\fR exists right now, then a NULL
                     46: pointer is returned.
                     47: 
                     48: .SH KEYWORDS
                     49: interpreter, global, local, variable

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.