summaryrefslogtreecommitdiffstats
path: root/doc/SetVar.3
diff options
context:
space:
mode:
authordkf <dkf@noemail.net>2004-09-18 17:01:01 (GMT)
committerdkf <dkf@noemail.net>2004-09-18 17:01:01 (GMT)
commita456eaa8a41f9d4c64f99bc835427017c15224a7 (patch)
treed0721a6b5b5206782155cb04dd3b28fd41bd8564 /doc/SetVar.3
parent5caca4abc826902d67902b0bb5841dc23e606573 (diff)
downloadtcl-a456eaa8a41f9d4c64f99bc835427017c15224a7.zip
tcl-a456eaa8a41f9d4c64f99bc835427017c15224a7.tar.gz
tcl-a456eaa8a41f9d4c64f99bc835427017c15224a7.tar.bz2
More fixes from Mikhail Kolesnitchenko, and also standardize highlighting
of symbols like TCL_OK, TCL_ERROR, etc. FossilOrigin-Name: 98776f715157a84ebbced1be85ea316525ae8c3f
Diffstat (limited to 'doc/SetVar.3')
-rw-r--r--doc/SetVar.314
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/SetVar.3 b/doc/SetVar.3
index c18c4c1..36f1a47 100644
--- a/doc/SetVar.3
+++ b/doc/SetVar.3
@@ -5,7 +5,7 @@
'\" 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.9 2004/08/16 14:11:16 msofer Exp $
+'\" RCS: @(#) $Id: SetVar.3,v 1.10 2004/09/18 17:01:06 dkf Exp $
'\"
.so man.macros
.TH Tcl_SetVar 3 8.1 Tcl "Tcl Library Procedures"
@@ -139,9 +139,9 @@ 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 is successfully removed then \fBTCL_OK\fR is returned.
If the variable cannot be removed because it doesn't exist then
-TCL_ERROR is returned and an error message is left
+\fBTCL_ERROR\fR 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
@@ -233,8 +233,8 @@ 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
+\fBTcl_GetVar\fR and \fBTcl_GetVar2\fR use the flag bits \fBTCL_GLOBAL_ONLY\fR
+and \fBTCL_LEAVE_ERR_MSG\fR, both of
which have
the same meaning as for \fBTcl_SetVar\fR.
If an error occurs in reading the variable (e.g. the variable
@@ -246,9 +246,9 @@ 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 is successfully removed then \fBTCL_OK\fR is returned.
If the variable cannot be removed because it doesn't exist then
-TCL_ERROR is returned.
+\fBTCL_ERROR\fR 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