summaryrefslogtreecommitdiffstats
path: root/doc/LinkVar.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-09-18 17:01:02 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-09-18 17:01:02 (GMT)
commit5e5bcd132f05719b0bd2dbd8449cc26b325ef811 (patch)
treed0721a6b5b5206782155cb04dd3b28fd41bd8564 /doc/LinkVar.3
parent5c5d25ff6d6cf79ce06105cd339492f10e32aa82 (diff)
downloadtcl-5e5bcd132f05719b0bd2dbd8449cc26b325ef811.zip
tcl-5e5bcd132f05719b0bd2dbd8449cc26b325ef811.tar.gz
tcl-5e5bcd132f05719b0bd2dbd8449cc26b325ef811.tar.bz2
More fixes from Mikhail Kolesnitchenko, and also standardize highlighting
of symbols like TCL_OK, TCL_ERROR, etc.
Diffstat (limited to 'doc/LinkVar.3')
-rw-r--r--doc/LinkVar.318
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/LinkVar.3 b/doc/LinkVar.3
index 300482a..2741685 100644
--- a/doc/LinkVar.3
+++ b/doc/LinkVar.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: LinkVar.3,v 1.7 2003/07/18 16:56:41 dgp Exp $
+'\" RCS: @(#) $Id: LinkVar.3,v 1.8 2004/09/18 17:01:06 dkf Exp $
'\"
.so man.macros
.TH Tcl_LinkVar 3 7.5 Tcl "Tcl Library Procedures"
@@ -32,12 +32,12 @@ Name of global variable.
.AP char *addr in
Address of C variable that is to be linked to \fIvarName\fR.
.AP int type in
-Type of C variable. Must be one of TCL_LINK_INT, TCL_LINK_DOUBLE,
+Type of C variable. Must be one of \fBTCL_LINK_INT\fR, \fBTCL_LINK_DOUBLE\fR,
.VS 8.4
-TCL_LINK_WIDE_INT,
+\fBTCL_LINK_WIDE_INT\fR,
.VE 8.4
-TCL_LINK_BOOLEAN, or TCL_LINK_STRING, optionally OR'ed with
-TCL_LINK_READ_ONLY to make Tcl variable read-only.
+\fBTCL_LINK_BOOLEAN\fR, or \fBTCL_LINK_STRING\fR, optionally OR'ed with
+\fBTCL_LINK_READ_ONLY\fR to make Tcl variable read-only.
.BE
.SH DESCRIPTION
@@ -48,14 +48,14 @@ given by \fIaddr\fR.
Whenever the Tcl variable is read the value of the C variable will
be returned, and whenever the Tcl variable is written the C
variable will be updated to have the same value.
-\fBTcl_LinkVar\fR normally returns TCL_OK; if an error occurs
+\fBTcl_LinkVar\fR normally returns \fBTCL_OK\fR; if an error occurs
while setting up the link (e.g. because \fIvarName\fR is the
-name of array) then TCL_ERROR is returned and the interpreter's result
+name of array) then \fBTCL_ERROR\fR is returned and the interpreter's result
contains an error message.
.PP
The \fItype\fR argument specifies the type of the C variable,
and must have one of the following values, optionally OR'ed with
-TCL_LINK_READ_ONLY:
+\fBTCL_LINK_READ_ONLY\fR:
.TP
\fBTCL_LINK_INT\fR
The C variable is of type \fBint\fR.
@@ -104,7 +104,7 @@ new value.
If the C variable contains a NULL pointer then the Tcl variable
will read as ``NULL''.
.PP
-If the TCL_LINK_READ_ONLY flag is present in \fItype\fR then the
+If the \fBTCL_LINK_READ_ONLY\fR flag is present in \fItype\fR then the
variable will be read-only from Tcl, so that its value can only be
changed by modifying the C variable.
Attempts to write the variable from Tcl will be rejected with errors.