summaryrefslogtreecommitdiffstats
path: root/doc/GetIndex.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-09-06 09:44:56 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-09-06 09:44:56 (GMT)
commit0e5952c887bd1c44ce8a13516659d6e763a2d381 (patch)
treef3df18b7b55fef1a57dbdfd4b3b9d48ee8923f16 /doc/GetIndex.3
parente61f35c191941709a727ae6128a43b24a0ee5bff (diff)
downloadtcl-0e5952c887bd1c44ce8a13516659d6e763a2d381.zip
tcl-0e5952c887bd1c44ce8a13516659d6e763a2d381.tar.gz
tcl-0e5952c887bd1c44ce8a13516659d6e763a2d381.tar.bz2
More documentation fixes from Mikhail Kolesnitchenko. [Patch 1022527]
Diffstat (limited to 'doc/GetIndex.3')
-rw-r--r--doc/GetIndex.311
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/GetIndex.3 b/doc/GetIndex.3
index 724fe34..ec43774 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.11 2003/07/18 16:56:41 dgp Exp $
+'\" RCS: @(#) $Id: GetIndex.3,v 1.12 2004/09/06 09:44:56 dkf Exp $
'\"
.so man.macros
.TH Tcl_GetIndexFromObj 3 8.1 Tcl "Tcl Library Procedures"
@@ -92,9 +92,12 @@ and return TCL_ERROR.
.PP
\fBTcl_GetIndexFromObjStruct\fR works just like
\fBTcl_GetIndexFromObj\fR, except that instead of treating
-\fItablePtr\fR as an array of string pointers, it treats it as the
-first in a series of string ptrs that are spaced apart by \fIoffset\fR
-bytes. This is particularly useful when processing things like
+\fItablePtr\fR as an array of string pointers, it treats it as a
+pointer to the first string in a series of strings that have
+\fIoffset\fR bytes between them (i.e. that there is a pointer to the
+first array of characters at \fItablePtr\fR, a pointer to the second
+array of characters at \fItablePtr\fR+\fIoffset\fR bytes, etc.)
+This is particularly useful when processing things like
\fBTk_ConfigurationSpec\fR, whose string keys are in the same place in
each of several array elements.
.VE