summaryrefslogtreecommitdiffstats
path: root/doc/GetIndex.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/GetIndex.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/GetIndex.3')
-rw-r--r--doc/GetIndex.38
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/GetIndex.3 b/doc/GetIndex.3
index ec43774..3d67486 100644
--- a/doc/GetIndex.3
+++ b/doc/GetIndex.3
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: GetIndex.3,v 1.12 2004/09/06 09:44:56 dkf Exp $
+'\" RCS: @(#) $Id: GetIndex.3,v 1.13 2004/09/18 17:01:06 dkf Exp $
'\"
.so man.macros
.TH Tcl_GetIndexFromObj 3 8.1 Tcl "Tcl Library Procedures"
@@ -68,10 +68,10 @@ the strings in \fItablePtr\fR to find a match. A match occurs if
for exactly one of the strings in \fItablePtr\fR and the
\fBTCL_EXACT\fR flag was not specified; in either case
the index of the matching entry is stored at \fI*indexPtr\fR
-and TCL_OK is returned.
+and \fBTCL_OK\fR is returned.
.PP
If there is no matching entry,
-TCL_ERROR is returned and an error message is left in \fIinterp\fR's
+\fBTCL_ERROR\fR is returned and an error message is left in \fIinterp\fR's
result if \fIinterp\fR isn't NULL. \fIMsg\fR is included in the
error message to indicate what was being looked up. For example,
if \fImsg\fR is \fBoption\fR the error message will have a form like
@@ -87,7 +87,7 @@ operation. Note: \fBTcl_GetIndexFromObj\fR assumes that the entries
in \fItablePtr\fR are static: they must not change between
invocations. If the value of \fIobjPtr\fR is the empty string,
\fBTcl_GetIndexFromObj\fR will treat it as a non-matching value
-and return TCL_ERROR.
+and return \fBTCL_ERROR\fR.
.VS
.PP
\fBTcl_GetIndexFromObjStruct\fR works just like