summaryrefslogtreecommitdiffstats
path: root/doc/GetIndex.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2012-11-19 22:10:10 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2012-11-19 22:10:10 (GMT)
commit6ba5327e8579861a348ee361e3aff04356086458 (patch)
tree9790caf5f3e563afb49a9b98f35fe6c8f92fb8df /doc/GetIndex.3
parent2e165c349a1c7b8d6a62f5b97adfff7f2b0ae80f (diff)
parent094f23c172acca8f32b0888cd536f01fc1daab1b (diff)
downloadtcl-6ba5327e8579861a348ee361e3aff04356086458.zip
tcl-6ba5327e8579861a348ee361e3aff04356086458.tar.gz
tcl-6ba5327e8579861a348ee361e3aff04356086458.tar.bz2
merge trunk
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 50607ae..d32561a 100644
--- a/doc/GetIndex.3
+++ b/doc/GetIndex.3
@@ -26,7 +26,7 @@ int
Interpreter to use for error reporting; if NULL, then no message is
provided on errors.
.AP Tcl_Obj *objPtr in/out
-The string value of this object is used to search through \fItablePtr\fR.
+The string value of this value is used to search through \fItablePtr\fR.
The internal representation is modified to hold the index of the matching
table entry.
.AP "const char *const" *tablePtr in
@@ -58,8 +58,8 @@ The index of the string in \fItablePtr\fR that matches the value of
.SH DESCRIPTION
.PP
These procedures provide an efficient way for looking up keywords,
-switch names, option names, and similar things where the value of
-an object must be one of a predefined set of values.
+switch names, option names, and similar things where the literal value of
+a Tcl value must be chosen from a predefined set.
\fBTcl_GetIndexFromObj\fR compares \fIobjPtr\fR against each of
the strings in \fItablePtr\fR to find a match. A match occurs if
\fIobjPtr\fR's string value is identical to one of the strings in
@@ -101,4 +101,4 @@ each of several array elements.
.SH "SEE ALSO"
prefix(n), Tcl_WrongNumArgs(3)
.SH KEYWORDS
-index, object, table lookup
+index, option, value, table lookup