man/man3/Tcl_ObjSetVar2.3 - toolchains/skids - Git at Google

 '\"
 '\" Copyright (c) 1989-1993 The Regents of the University of California.
 '\" Copyright (c) 1994-1997 Sun Microsystems, Inc.
 '\"
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\"
 '\" RCS: @(#) $Id: SetVar.3,v 1.7 2002/08/05 03:24:39 dgp Exp $
 '\"
 '\" The definitions below are for supplemental macros used in Tcl/Tk
 '\" manual entries.
 '\"
 '\" .AP type name in/out ?indent?
 '\"	Start paragraph describing an argument to a library procedure.
 '\"	type is type of argument (int, etc.), in/out is either "in", "out",
 '\"	or "in/out" to describe whether procedure reads or modifies arg,
 '\"	and indent is equivalent to second arg of .IP (shouldn't ever be
 '\"	needed;  use .AS below instead)
 '\"
 '\" .AS ?type? ?name?
 '\"	Give maximum sizes of arguments for setting tab stops.  Type and
 '\"	name are examples of largest possible arguments that will be passed
 '\"	to .AP later.  If args are omitted, default tab stops are used.
 '\"
 '\" .BS
 '\"	Start box enclosure.  From here until next .BE, everything will be
 '\"	enclosed in one large box.
 '\"
 '\" .BE
 '\"	End of box enclosure.
 '\"
 '\" .CS
 '\"	Begin code excerpt.
 '\"
 '\" .CE
 '\"	End code excerpt.
 '\"
 '\" .VS ?version? ?br?
 '\"	Begin vertical sidebar, for use in marking newly-changed parts
 '\"	of man pages.  The first argument is ignored and used for recording
 '\"	the version when the .VS was added, so that the sidebars can be
 '\"	found and removed when they reach a certain age.  If another argument
 '\"	is present, then a line break is forced before starting the sidebar.
 '\"
 '\" .VE
 '\"	End of vertical sidebar.
 '\"
 '\" .DS
 '\"	Begin an indented unfilled display.
 '\"
 '\" .DE
 '\"	End of indented unfilled display.
 '\"
 '\" .SO
 '\"	Start of list of standard options for a Tk widget.  The
 '\"	options follow on successive lines, in four columns separated
 '\"	by tabs.
 '\"
 '\" .SE
 '\"	End of list of standard options for a Tk widget.
 '\"
 '\" .OP cmdName dbName dbClass
 '\"	Start of description of a specific option.  cmdName gives the
 '\"	option's name as specified in the class command, dbName gives
 '\"	the option's name in the option database, and dbClass gives
 '\"	the option's class in the option database.
 '\"
 '\" .UL arg1 arg2
 '\"	Print arg1 underlined, then print arg2 normally.
 '\"
 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
 '\"
 '\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
 .if t .wh -1.3i ^B
 .nr ^l \n(.l
 .ad b
 '\"	# Start an argument description
 .de AP
 .ie !"\\$4"" .TP \\$4
 .el \{\
 .   ie !"\\$2"" .TP \\n()Cu
 .   el          .TP 15
 .\}
 .ta \\n()Au \\n()Bu
 .ie !"\\$3"" \{\
 \&\\$1	\\fI\\$2\\fP	(\\$3)
 .\".b
 .\}
 .el \{\
 .br
 .ie !"\\$2"" \{\
 \&\\$1	\\fI\\$2\\fP
 .\}
 .el \{\
 \&\\fI\\$1\\fP
 .\}
 .\}
 ..
 '\"	# define tabbing values for .AP
 .de AS
 .nr )A 10n
 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 .nr )B \\n()Au+15n
 .\"
 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 ..
 .AS Tcl_Interp Tcl_CreateInterp in/out
 '\"	# BS - start boxed text
 '\"	# ^y = starting y location
 '\"	# ^b = 1
 .de BS
 .br
 .mk ^y
 .nr ^b 1u
 .if n .nf
 .if n .ti 0
 .if n \l'\\n(.lu\(ul'
 .if n .fi
 ..
 '\"	# BE - end boxed text (draw box now)
 .de BE
 .nf
 .ti 0
 .mk ^t
 .ie n \l'\\n(^lu\(ul'
 .el \{\
 .\"	Draw four-sided box normally, but don't draw top of
 .\"	box if the box started on an earlier page.
 .ie !\\n(^b-1 \{\
 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 .\}
 .el \}\
 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 .\}
 .\}
 .fi
 .br
 .nr ^b 0
 ..
 '\"	# VS - start vertical sidebar
 '\"	# ^Y = starting y location
 '\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
 .de VS
 .if !"\\$2"" .br
 .mk ^Y
 .ie n 'mc \s12\(br\s0
 .el .nr ^v 1u
 ..
 '\"	# VE - end of vertical sidebar
 .de VE
 .ie n 'mc
 .el \{\
 .ev 2
 .nf
 .ti 0
 .mk ^t
 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 .sp -1
 .fi
 .ev
 .\}
 .nr ^v 0
 ..
 '\"	# Special macro to handle page bottom:  finish off current
 '\"	# box/sidebar if in box/sidebar mode, then invoked standard
 '\"	# page bottom macro.
 .de ^B
 .ev 2
 'ti 0
 'nf
 .mk ^t
 .if \\n(^b \{\
 .\"	Draw three-sided box if this is the box's first page,
 .\"	draw two sides but no top otherwise.
 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 .\}
 .if \\n(^v \{\
 .nr ^x \\n(^tu+1v-\\n(^Yu
 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 .\}
 .bp
 'fi
 .ev
 .if \\n(^b \{\
 .mk ^y
 .nr ^b 2
 .\}
 .if \\n(^v \{\
 .mk ^Y
 .\}
 ..
 '\"	# DS - begin display
 .de DS
 .RS
 .nf
 .sp
 ..
 '\"	# DE - end display
 .de DE
 .fi
 .RE
 .sp
 ..
 '\"	# SO - start of list of standard options
 .de SO
 .SH "STANDARD OPTIONS"
 .LP
 .nf
 .ta 5.5c 11c
 .ft B
 ..
 '\"	# SE - end of list of standard options
 .de SE
 .fi
 .ft R
 .LP
 See the \\fBoptions\\fR manual entry for details on the standard options.
 ..
 '\"	# OP - start of full description for a single option
 .de OP
 .LP
 .nf
 .ta 4c
 Command-Line Name:	\\fB\\$1\\fR
 Database Name:	\\fB\\$2\\fR
 Database Class:	\\fB\\$3\\fR
 .fi
 .IP
 ..
 '\"	# CS - begin code excerpt
 .de CS
 .RS
 .nf
 .ta .25i .5i .75i 1i
 ..
 '\"	# CE - end code excerpt
 .de CE
 .fi
 .RE
 ..
 .de UL
 \\$1\l'|0\(ul'\\$2
 ..
 .TH Tcl_SetVar 3 8.1 Tcl "Tcl Library Procedures"
 .BS
 .SH NAME
 Tcl_SetVar2Ex, Tcl_SetVar, Tcl_SetVar2, Tcl_ObjSetVar2, Tcl_GetVar2Ex, Tcl_GetVar, Tcl_GetVar2, Tcl_ObjGetVar2, Tcl_UnsetVar, Tcl_UnsetVar2 \- manipulate Tcl variables
 .SH SYNOPSIS
 .nf
 \fB#include <tcl.h>\fR
 .sp
 .VS 8.1
 Tcl_Obj *
 \fBTcl_SetVar2Ex\fR(\fIinterp, name1, name2, newValuePtr, flags\fR)
 .VE
 .sp
 CONST char *
 \fBTcl_SetVar\fR(\fIinterp, varName, newValue, flags\fR)
 .sp
 CONST char *
 \fBTcl_SetVar2\fR(\fIinterp, name1, name2, newValue, flags\fR)
 .sp
 Tcl_Obj *
 \fBTcl_ObjSetVar2\fR(\fIinterp, part1Ptr, part2Ptr, newValuePtr, flags\fR)
 .sp
 .VS 8.1
 Tcl_Obj *
 \fBTcl_GetVar2Ex\fR(\fIinterp, name1, name2, flags\fR)
 .VE
 .sp
 CONST char *
 \fBTcl_GetVar\fR(\fIinterp, varName, flags\fR)
 .sp
 CONST char *
 \fBTcl_GetVar2\fR(\fIinterp, name1, name2, flags\fR)
 .sp
 Tcl_Obj *
 \fBTcl_ObjGetVar2\fR(\fIinterp, part1Ptr, part2Ptr, flags\fR)
 .sp
 int
 \fBTcl_UnsetVar\fR(\fIinterp, varName, flags\fR)
 .sp
 int
 \fBTcl_UnsetVar2\fR(\fIinterp, name1, name2, flags\fR)
 .SH ARGUMENTS
 .AS Tcl_Interp *newValuePtr
 .AP Tcl_Interp *interp in
 Interpreter containing variable.
 .AP "CONST char" *name1 in
 Contains the name of an array variable (if \fIname2\fR is non-NULL)
 or (if \fIname2\fR is NULL) either the name of a scalar variable
 or a complete name including both variable name and index.
 May include \fB::\fR namespace qualifiers
 to specify a variable in a particular namespace.
 .AP "CONST char" *name2 in
 If non-NULL, gives name of element within array; in this
 case \fIname1\fR must refer to an array variable.
 .AP Tcl_Obj *newValuePtr in
 .VS 8.1
 Points to a Tcl object containing the new value for the variable.
 .VE
 .AP int flags in
 OR-ed combination of bits providing additional information. See below
 for valid values.
 .AP "CONST char" *varName in
 Name of variable.
 May include \fB::\fR namespace qualifiers
 to specify a variable in a particular namespace.
 May refer to a scalar variable or an element of
 an array.
 .AP "CONST char" *newValue in
 New value for variable, specified as a NULL-terminated string.
 A copy of this value is stored in the variable.
 .AP Tcl_Obj *part1Ptr in
 Points to a Tcl object containing the variable's name.
 The name may include a series of \fB::\fR namespace qualifiers
 to specify a variable in a particular namespace.
 May refer to a scalar variable or an element of an array variable.
 .AP Tcl_Obj *part2Ptr in
 If non-NULL, points to an object containing the name of an element
 within an array and \fIpart1Ptr\fR must refer to an array variable.
 .BE

 .SH DESCRIPTION
 .PP
 These procedures are used to create, modify, read, and delete
 Tcl variables from C code.
 .PP
 .VS 8.1
 \fBTcl_SetVar2Ex\fR, \fBTcl_SetVar\fR, \fBTcl_SetVar2\fR, and
 \fBTcl_ObjSetVar2\fR
 will create a new variable or modify an existing one.
 These procedures set the given variable to the value
 given by \fInewValuePtr\fR or \fInewValue\fR and return a
 pointer to the variable's new value, which is stored in Tcl's
 variable structure.
 \fBTcl_SetVar2Ex\fR and \fBTcl_ObjSetVar2\fR take the new value as a
 Tcl_Obj and return
 a pointer to a Tcl_Obj.  \fBTcl_SetVar\fR and \fBTcl_SetVar2\fR
 take the new value as a string and return a string; they are
 usually less efficient than \fBTcl_ObjSetVar2\fR.  Note that the
 return value may be different than the \fInewValuePtr\fR or
 .VE
 \fInewValue\fR argument, due to modifications made by write traces.
 If an error occurs in setting the variable (e.g. an array
 variable is referenced without giving an index into the array)
 NULL is returned and an error message is left in \fIinterp\fR's
 result if the \fBTCL_LEAVE_ERR_MSG\fR \fIflag\fR bit is set.
 .PP
 .VS 8.1
 \fBTcl_GetVar2Ex\fR, \fBTcl_GetVar\fR, \fBTcl_GetVar2\fR, and
 \fBTcl_ObjGetVar2\fR
 return the current value of a variable.
 The arguments to these procedures are treated in the same way
 as the arguments to the procedures described above.
 Under normal circumstances, the return value is a pointer
 to the variable's value.  For \fBTcl_GetVar2Ex\fR and
 \fBTcl_ObjGetVar2\fR the value is
 returned as a pointer to a Tcl_Obj.  For \fBTcl_GetVar\fR and
 \fBTcl_GetVar2\fR the value is returned as a string; this is
 usually less efficient, so \fBTcl_GetVar2Ex\fR or \fBTcl_ObjGetVar2\fR
 are preferred.
 .VE
 If an error occurs while reading the variable (e.g. the variable
 doesn't exist or an array element is specified for a scalar
 variable), then NULL is returned and an error message is left
 in \fIinterp\fR's result if the \fBTCL_LEAVE_ERR_MSG\fR \fIflag\fR
 bit is set.
 .PP
 \fBTcl_UnsetVar\fR and \fBTcl_UnsetVar2\fR may be used to remove
 a variable, so that future attempts to read the variable will return
 an error.
 The arguments to these procedures are treated in the same way
 as the arguments to the procedures above.
 If the variable is successfully removed then TCL_OK is returned.
 If the variable cannot be removed because it doesn't exist then
 TCL_ERROR is returned and an error message is left
 in \fIinterp\fR's result if the \fBTCL_LEAVE_ERR_MSG\fR \fIflag\fR
 bit is set.
 If an array element is specified, the given element is removed
 but the array remains.
 If an array name is specified without an index, then the entire
 array is removed.
 .PP
 The name of a variable may be specified to these procedures in
 four ways:
 .IP [1]
 If \fBTcl_SetVar\fR, \fBTcl_GetVar\fR, or \fBTcl_UnsetVar\fR
 is invoked, the variable name is given as
 a single string, \fIvarName\fR.
 If \fIvarName\fR contains an open parenthesis and ends with a
 close parenthesis, then the value between the parentheses is
 treated as an index (which can have any string value) and
 the characters before the first open
 parenthesis are treated as the name of an array variable.
 If \fIvarName\fR doesn't have parentheses as described above, then
 the entire string is treated as the name of a scalar variable.
 .IP [2]
 If the \fIname1\fR and \fIname2\fR arguments are provided and
 \fIname2\fR is non-NULL, then an array element is specified and
 the array name and index have
 already been separated by the caller: \fIname1\fR contains the
 name and \fIname2\fR contains the index.
 .VS 8.1
 An error is generated
 if \fIname1\fR  contains an open parenthesis and ends with a
 close parenthesis (array element) and \fIname2\fR is non-NULL.
 .IP [3]
 If \fIname2\fR is NULL, \fIname1\fR is treated just like
 \fIvarName\fR in case [1] above (it can be either a scalar or an array
 element variable name).
 .VE
 .PP
 The \fIflags\fR argument may be used to specify any of several
 options to the procedures.
 It consists of an OR-ed combination of the following bits.
 .TP
 \fBTCL_GLOBAL_ONLY\fR
 Under normal circumstances the procedures look up variables as follows.
 If a procedure call is active in \fIinterp\fR,
 the variable is looked up at the current level of procedure call.
 Otherwise, the variable is looked up first in the current namespace,
 then in the global namespace.
 However, if this bit is set in \fIflags\fR then the variable
 is looked up only in the global namespace
 even if there is a procedure call active.
 If both \fBTCL_GLOBAL_ONLY\fR and \fBTCL_NAMESPACE_ONLY\fR are given,
 \fBTCL_GLOBAL_ONLY\fR is ignored.
 .TP
 \fBTCL_NAMESPACE_ONLY\fR
 If this bit is set in \fIflags\fR then the variable
 is looked up only in the current namespace; if a procedure is active
 its variables are ignored, and the global namespace is also ignored unless
 it is the current namespace.
 .TP
 \fBTCL_LEAVE_ERR_MSG\fR
 If an error is returned and this bit is set in \fIflags\fR, then
 an error message will be left in the interpreter's result,
 where it can be retrieved with \fBTcl_GetObjResult\fR
 or \fBTcl_GetStringResult\fR.
 If this flag bit isn't set then no error message is left
 and the interpreter's result will not be modified.
 .TP
 \fBTCL_APPEND_VALUE\fR
 If this bit is set then \fInewValuePtr\fR or \fInewValue\fR is
 appended to the current value instead of replacing it.
 If the variable is currently undefined, then the bit is ignored.
 This bit is only used by the \fBTcl_Set*\fR procedures.
 .TP
 \fBTCL_LIST_ELEMENT\fR
 If this bit is set, then \fInewValue\fR is converted to a valid
 Tcl list element before setting (or appending to) the variable.
 A separator space is appended before the new list element unless
 the list element is going to be the first element in a list or
 sublist (i.e. the variable's current value is empty, or contains
 the single character ``{'', or ends in `` }'').
 .PP
 \fBTcl_GetVar\fR and \fBTcl_GetVar2\fR
 return the current value of a variable.
 The arguments to these procedures are treated in the same way
 as the arguments to \fBTcl_SetVar\fR and \fBTcl_SetVar2\fR.
 Under normal circumstances, the return value is a pointer
 to the variable's value (which is stored in Tcl's variable
 structure and will not change before the next call to \fBTcl_SetVar\fR
 or \fBTcl_SetVar2\fR).
 \fBTcl_GetVar\fR and \fBTcl_GetVar2\fR use the flag bits TCL_GLOBAL_ONLY
 and TCL_LEAVE_ERR_MSG, both of
 which have
 the same meaning as for \fBTcl_SetVar\fR.
 If an error occurs in reading the variable (e.g. the variable
 doesn't exist or an array element is specified for a scalar
 variable), then NULL is returned.
 .PP
 \fBTcl_UnsetVar\fR and \fBTcl_UnsetVar2\fR may be used to remove
 a variable, so that future calls to \fBTcl_GetVar\fR or \fBTcl_GetVar2\fR
 for the variable will return an error.
 The arguments to these procedures are treated in the same way
 as the arguments to \fBTcl_GetVar\fR and \fBTcl_GetVar2\fR.
 If the variable is successfully removed then TCL_OK is returned.
 If the variable cannot be removed because it doesn't exist then
 TCL_ERROR is returned.
 If an array element is specified, the given element is removed
 but the array remains.
 If an array name is specified without an index, then the entire
 array is removed.

 .SH "SEE ALSO"
 Tcl_GetObjResult, Tcl_GetStringResult, Tcl_TraceVar

 .SH KEYWORDS
 array, get variable, interpreter, object, scalar, set, unset, variable
	'\"
	'\" Copyright (c) 1989-1993 The Regents of the University of California.
	'\" Copyright (c) 1994-1997 Sun Microsystems, Inc.
	'\"
	'\" See the file "license.terms" for information on usage and redistribution
	'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
	'\"
	'\" RCS: @(#) $Id: SetVar.3,v 1.7 2002/08/05 03:24:39 dgp Exp $
	'\"
	'\" The definitions below are for supplemental macros used in Tcl/Tk
	'\" manual entries.
	'\"
	'\" .AP type name in/out ?indent?
	'\" Start paragraph describing an argument to a library procedure.
	'\" type is type of argument (int, etc.), in/out is either "in", "out",
	'\" or "in/out" to describe whether procedure reads or modifies arg,
	'\" and indent is equivalent to second arg of .IP (shouldn't ever be
	'\" needed; use .AS below instead)
	'\"
	'\" .AS ?type? ?name?
	'\" Give maximum sizes of arguments for setting tab stops. Type and
	'\" name are examples of largest possible arguments that will be passed
	'\" to .AP later. If args are omitted, default tab stops are used.
	'\"
	'\" .BS
	'\" Start box enclosure. From here until next .BE, everything will be
	'\" enclosed in one large box.
	'\"
	'\" .BE
	'\" End of box enclosure.
	'\"
	'\" .CS
	'\" Begin code excerpt.
	'\"
	'\" .CE
	'\" End code excerpt.
	'\"
	'\" .VS ?version? ?br?
	'\" Begin vertical sidebar, for use in marking newly-changed parts
	'\" of man pages. The first argument is ignored and used for recording
	'\" the version when the .VS was added, so that the sidebars can be
	'\" found and removed when they reach a certain age. If another argument
	'\" is present, then a line break is forced before starting the sidebar.
	'\"
	'\" .VE
	'\" End of vertical sidebar.
	'\"
	'\" .DS
	'\" Begin an indented unfilled display.
	'\"
	'\" .DE
	'\" End of indented unfilled display.
	'\"
	'\" .SO
	'\" Start of list of standard options for a Tk widget. The
	'\" options follow on successive lines, in four columns separated
	'\" by tabs.
	'\"
	'\" .SE
	'\" End of list of standard options for a Tk widget.
	'\"
	'\" .OP cmdName dbName dbClass
	'\" Start of description of a specific option. cmdName gives the
	'\" option's name as specified in the class command, dbName gives
	'\" the option's name in the option database, and dbClass gives
	'\" the option's class in the option database.
	'\"
	'\" .UL arg1 arg2
	'\" Print arg1 underlined, then print arg2 normally.
	'\"
	'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
	'\"
	'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
	.if t .wh -1.3i ^B
	.nr ^l \n(.l
	.ad b
	'\" # Start an argument description
	.de AP
	.ie !"\\$4"" .TP \\$4
	.el \{\
	. ie !"\\$2"" .TP \\n()Cu
	. el .TP 15
	.\}
	.ta \\n()Au \\n()Bu
	.ie !"\\$3"" \{\
	\&\\$1 \\fI\\$2\\fP (\\$3)
	.\".b
	.\}
	.el \{\
	.br
	.ie !"\\$2"" \{\
	\&\\$1 \\fI\\$2\\fP
	.\}
	.el \{\
	\&\\fI\\$1\\fP
	.\}
	.\}
	..
	'\" # define tabbing values for .AP
	.de AS
	.nr )A 10n
	.if !"\\$1"" .nr )A \\w'\\$1'u+3n
	.nr )B \\n()Au+15n
	.\"
	.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
	.nr )C \\n()Bu+\\w'(in/out)'u+2n
	..
	.AS Tcl_Interp Tcl_CreateInterp in/out
	'\" # BS - start boxed text
	'\" # ^y = starting y location
	'\" # ^b = 1
	.de BS
	.br
	.mk ^y
	.nr ^b 1u
	.if n .nf
	.if n .ti 0
	.if n \l'\\n(.lu\(ul'
	.if n .fi
	..
	'\" # BE - end boxed text (draw box now)
	.de BE
	.nf
	.ti 0
	.mk ^t
	.ie n \l'\\n(^lu\(ul'
	.el \{\
	.\" Draw four-sided box normally, but don't draw top of
	.\" box if the box started on an earlier page.
	.ie !\\n(^b-1 \{\
	\h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
	.\}
	.el \}\
	\h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
	.\}
	.\}
	.fi
	.br
	.nr ^b 0
	..
	'\" # VS - start vertical sidebar
	'\" # ^Y = starting y location
	'\" # ^v = 1 (for troff; for nroff this doesn't matter)
	.de VS
	.if !"\\$2"" .br
	.mk ^Y
	.ie n 'mc \s12\(br\s0
	.el .nr ^v 1u
	..
	'\" # VE - end of vertical sidebar
	.de VE
	.ie n 'mc
	.el \{\
	.ev 2
	.nf
	.ti 0
	.mk ^t
	\h'\|\\n(^lu+3n'\L'\|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-\|\\n(^lu+3n'
	.sp -1
	.fi
	.ev
	.\}
	.nr ^v 0
	..
	'\" # Special macro to handle page bottom: finish off current
	'\" # box/sidebar if in box/sidebar mode, then invoked standard
	'\" # page bottom macro.
	.de ^B
	.ev 2
	'ti 0
	'nf
	.mk ^t
	.if \\n(^b \{\
	.\" Draw three-sided box if this is the box's first page,
	.\" draw two sides but no top otherwise.
	.ie !\\n(^b-1 \h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
	.el \h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
	.\}
	.if \\n(^v \{\
	.nr ^x \\n(^tu+1v-\\n(^Yu
	\kx\h'-\\nxu'\h'\|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'\|0u'\c
	.\}
	.bp
	'fi
	.ev
	.if \\n(^b \{\
	.mk ^y
	.nr ^b 2
	.\}
	.if \\n(^v \{\
	.mk ^Y
	.\}
	..
	'\" # DS - begin display
	.de DS
	.RS
	.nf
	.sp
	..
	'\" # DE - end display
	.de DE
	.fi
	.RE
	.sp
	..
	'\" # SO - start of list of standard options
	.de SO
	.SH "STANDARD OPTIONS"
	.LP
	.nf
	.ta 5.5c 11c
	.ft B
	..
	'\" # SE - end of list of standard options
	.de SE
	.fi
	.ft R
	.LP
	See the \\fBoptions\\fR manual entry for details on the standard options.
	..
	'\" # OP - start of full description for a single option
	.de OP
	.LP
	.nf
	.ta 4c
	Command-Line Name: \\fB\\$1\\fR
	Database Name: \\fB\\$2\\fR
	Database Class: \\fB\\$3\\fR
	.fi
	.IP
	..
	'\" # CS - begin code excerpt
	.de CS
	.RS
	.nf
	.ta .25i .5i .75i 1i
	..
	'\" # CE - end code excerpt
	.de CE
	.fi
	.RE
	..
	.de UL
	\\$1\l'\|0\(ul'\\$2
	..
	.TH Tcl_SetVar 3 8.1 Tcl "Tcl Library Procedures"
	.BS
	.SH NAME
	Tcl_SetVar2Ex, Tcl_SetVar, Tcl_SetVar2, Tcl_ObjSetVar2, Tcl_GetVar2Ex, Tcl_GetVar, Tcl_GetVar2, Tcl_ObjGetVar2, Tcl_UnsetVar, Tcl_UnsetVar2 \- manipulate Tcl variables
	.SH SYNOPSIS
	.nf
	\fB#include <tcl.h>\fR
	.sp
	.VS 8.1
	Tcl_Obj *
	\fBTcl_SetVar2Ex\fR(\fIinterp, name1, name2, newValuePtr, flags\fR)
	.VE
	.sp
	CONST char *
	\fBTcl_SetVar\fR(\fIinterp, varName, newValue, flags\fR)
	.sp
	CONST char *
	\fBTcl_SetVar2\fR(\fIinterp, name1, name2, newValue, flags\fR)
	.sp
	Tcl_Obj *
	\fBTcl_ObjSetVar2\fR(\fIinterp, part1Ptr, part2Ptr, newValuePtr, flags\fR)
	.sp
	.VS 8.1
	Tcl_Obj *
	\fBTcl_GetVar2Ex\fR(\fIinterp, name1, name2, flags\fR)
	.VE
	.sp
	CONST char *
	\fBTcl_GetVar\fR(\fIinterp, varName, flags\fR)
	.sp
	CONST char *
	\fBTcl_GetVar2\fR(\fIinterp, name1, name2, flags\fR)
	.sp
	Tcl_Obj *
	\fBTcl_ObjGetVar2\fR(\fIinterp, part1Ptr, part2Ptr, flags\fR)
	.sp
	int
	\fBTcl_UnsetVar\fR(\fIinterp, varName, flags\fR)
	.sp
	int
	\fBTcl_UnsetVar2\fR(\fIinterp, name1, name2, flags\fR)
	.SH ARGUMENTS
	.AS Tcl_Interp *newValuePtr
	.AP Tcl_Interp *interp in
	Interpreter containing variable.
	.AP "CONST char" *name1 in
	Contains the name of an array variable (if \fIname2\fR is non-NULL)
	or (if \fIname2\fR is NULL) either the name of a scalar variable
	or a complete name including both variable name and index.
	May include \fB::\fR namespace qualifiers
	to specify a variable in a particular namespace.
	.AP "CONST char" *name2 in
	If non-NULL, gives name of element within array; in this
	case \fIname1\fR must refer to an array variable.
	.AP Tcl_Obj *newValuePtr in
	.VS 8.1
	Points to a Tcl object containing the new value for the variable.
	.VE
	.AP int flags in
	OR-ed combination of bits providing additional information. See below
	for valid values.
	.AP "CONST char" *varName in
	Name of variable.
	May include \fB::\fR namespace qualifiers
	to specify a variable in a particular namespace.
	May refer to a scalar variable or an element of
	an array.
	.AP "CONST char" *newValue in
	New value for variable, specified as a NULL-terminated string.
	A copy of this value is stored in the variable.
	.AP Tcl_Obj *part1Ptr in
	Points to a Tcl object containing the variable's name.
	The name may include a series of \fB::\fR namespace qualifiers
	to specify a variable in a particular namespace.
	May refer to a scalar variable or an element of an array variable.
	.AP Tcl_Obj *part2Ptr in
	If non-NULL, points to an object containing the name of an element
	within an array and \fIpart1Ptr\fR must refer to an array variable.
	.BE

	.SH DESCRIPTION
	.PP
	These procedures are used to create, modify, read, and delete
	Tcl variables from C code.
	.PP
	.VS 8.1
	\fBTcl_SetVar2Ex\fR, \fBTcl_SetVar\fR, \fBTcl_SetVar2\fR, and
	\fBTcl_ObjSetVar2\fR
	will create a new variable or modify an existing one.
	These procedures set the given variable to the value
	given by \fInewValuePtr\fR or \fInewValue\fR and return a
	pointer to the variable's new value, which is stored in Tcl's
	variable structure.
	\fBTcl_SetVar2Ex\fR and \fBTcl_ObjSetVar2\fR take the new value as a
	Tcl_Obj and return
	a pointer to a Tcl_Obj. \fBTcl_SetVar\fR and \fBTcl_SetVar2\fR
	take the new value as a string and return a string; they are
	usually less efficient than \fBTcl_ObjSetVar2\fR. Note that the
	return value may be different than the \fInewValuePtr\fR or
	.VE
	\fInewValue\fR argument, due to modifications made by write traces.
	If an error occurs in setting the variable (e.g. an array
	variable is referenced without giving an index into the array)
	NULL is returned and an error message is left in \fIinterp\fR's
	result if the \fBTCL_LEAVE_ERR_MSG\fR \fIflag\fR bit is set.
	.PP
	.VS 8.1
	\fBTcl_GetVar2Ex\fR, \fBTcl_GetVar\fR, \fBTcl_GetVar2\fR, and
	\fBTcl_ObjGetVar2\fR
	return the current value of a variable.
	The arguments to these procedures are treated in the same way
	as the arguments to the procedures described above.
	Under normal circumstances, the return value is a pointer
	to the variable's value. For \fBTcl_GetVar2Ex\fR and
	\fBTcl_ObjGetVar2\fR the value is
	returned as a pointer to a Tcl_Obj. For \fBTcl_GetVar\fR and
	\fBTcl_GetVar2\fR the value is returned as a string; this is
	usually less efficient, so \fBTcl_GetVar2Ex\fR or \fBTcl_ObjGetVar2\fR
	are preferred.
	.VE
	If an error occurs while reading the variable (e.g. the variable
	doesn't exist or an array element is specified for a scalar
	variable), then NULL is returned and an error message is left
	in \fIinterp\fR's result if the \fBTCL_LEAVE_ERR_MSG\fR \fIflag\fR
	bit is set.
	.PP
	\fBTcl_UnsetVar\fR and \fBTcl_UnsetVar2\fR may be used to remove
	a variable, so that future attempts to read the variable will return
	an error.
	The arguments to these procedures are treated in the same way
	as the arguments to the procedures above.
	If the variable is successfully removed then TCL_OK is returned.
	If the variable cannot be removed because it doesn't exist then
	TCL_ERROR is returned and an error message is left
	in \fIinterp\fR's result if the \fBTCL_LEAVE_ERR_MSG\fR \fIflag\fR
	bit is set.
	If an array element is specified, the given element is removed
	but the array remains.
	If an array name is specified without an index, then the entire
	array is removed.
	.PP
	The name of a variable may be specified to these procedures in
	four ways:
	.IP [1]
	If \fBTcl_SetVar\fR, \fBTcl_GetVar\fR, or \fBTcl_UnsetVar\fR
	is invoked, the variable name is given as
	a single string, \fIvarName\fR.
	If \fIvarName\fR contains an open parenthesis and ends with a
	close parenthesis, then the value between the parentheses is
	treated as an index (which can have any string value) and
	the characters before the first open
	parenthesis are treated as the name of an array variable.
	If \fIvarName\fR doesn't have parentheses as described above, then
	the entire string is treated as the name of a scalar variable.
	.IP [2]
	If the \fIname1\fR and \fIname2\fR arguments are provided and
	\fIname2\fR is non-NULL, then an array element is specified and
	the array name and index have
	already been separated by the caller: \fIname1\fR contains the
	name and \fIname2\fR contains the index.
	.VS 8.1
	An error is generated
	if \fIname1\fR contains an open parenthesis and ends with a
	close parenthesis (array element) and \fIname2\fR is non-NULL.
	.IP [3]
	If \fIname2\fR is NULL, \fIname1\fR is treated just like
	\fIvarName\fR in case [1] above (it can be either a scalar or an array
	element variable name).
	.VE
	.PP
	The \fIflags\fR argument may be used to specify any of several
	options to the procedures.
	It consists of an OR-ed combination of the following bits.
	.TP
	\fBTCL_GLOBAL_ONLY\fR
	Under normal circumstances the procedures look up variables as follows.
	If a procedure call is active in \fIinterp\fR,
	the variable is looked up at the current level of procedure call.
	Otherwise, the variable is looked up first in the current namespace,
	then in the global namespace.
	However, if this bit is set in \fIflags\fR then the variable
	is looked up only in the global namespace
	even if there is a procedure call active.
	If both \fBTCL_GLOBAL_ONLY\fR and \fBTCL_NAMESPACE_ONLY\fR are given,
	\fBTCL_GLOBAL_ONLY\fR is ignored.
	.TP
	\fBTCL_NAMESPACE_ONLY\fR
	If this bit is set in \fIflags\fR then the variable
	is looked up only in the current namespace; if a procedure is active
	its variables are ignored, and the global namespace is also ignored unless
	it is the current namespace.
	.TP
	\fBTCL_LEAVE_ERR_MSG\fR
	If an error is returned and this bit is set in \fIflags\fR, then
	an error message will be left in the interpreter's result,
	where it can be retrieved with \fBTcl_GetObjResult\fR
	or \fBTcl_GetStringResult\fR.
	If this flag bit isn't set then no error message is left
	and the interpreter's result will not be modified.
	.TP
	\fBTCL_APPEND_VALUE\fR
	If this bit is set then \fInewValuePtr\fR or \fInewValue\fR is
	appended to the current value instead of replacing it.
	If the variable is currently undefined, then the bit is ignored.
	This bit is only used by the \fBTcl_Set*\fR procedures.
	.TP
	\fBTCL_LIST_ELEMENT\fR
	If this bit is set, then \fInewValue\fR is converted to a valid
	Tcl list element before setting (or appending to) the variable.
	A separator space is appended before the new list element unless
	the list element is going to be the first element in a list or
	sublist (i.e. the variable's current value is empty, or contains
	the single character ``{'', or ends in `` }'').
	.PP
	\fBTcl_GetVar\fR and \fBTcl_GetVar2\fR
	return the current value of a variable.
	The arguments to these procedures are treated in the same way
	as the arguments to \fBTcl_SetVar\fR and \fBTcl_SetVar2\fR.
	Under normal circumstances, the return value is a pointer
	to the variable's value (which is stored in Tcl's variable
	structure and will not change before the next call to \fBTcl_SetVar\fR
	or \fBTcl_SetVar2\fR).
	\fBTcl_GetVar\fR and \fBTcl_GetVar2\fR use the flag bits TCL_GLOBAL_ONLY
	and TCL_LEAVE_ERR_MSG, both of
	which have
	the same meaning as for \fBTcl_SetVar\fR.
	If an error occurs in reading the variable (e.g. the variable
	doesn't exist or an array element is specified for a scalar
	variable), then NULL is returned.
	.PP
	\fBTcl_UnsetVar\fR and \fBTcl_UnsetVar2\fR may be used to remove
	a variable, so that future calls to \fBTcl_GetVar\fR or \fBTcl_GetVar2\fR
	for the variable will return an error.
	The arguments to these procedures are treated in the same way
	as the arguments to \fBTcl_GetVar\fR and \fBTcl_GetVar2\fR.
	If the variable is successfully removed then TCL_OK is returned.
	If the variable cannot be removed because it doesn't exist then
	TCL_ERROR is returned.
	If an array element is specified, the given element is removed
	but the array remains.
	If an array name is specified without an index, then the entire
	array is removed.

	.SH "SEE ALSO"
	Tcl_GetObjResult, Tcl_GetStringResult, Tcl_TraceVar

	.SH KEYWORDS
	array, get variable, interpreter, object, scalar, set, unset, variable