summaryrefslogtreecommitdiffstats
path: root/doc/GetIndex.3
diff options
context:
space:
mode:
authordgp <dgp@noemail.net>2002-02-28 05:11:24 (GMT)
committerdgp <dgp@noemail.net>2002-02-28 05:11:24 (GMT)
commitaddc87417c54bb55b560b9afdf106e3ee0db660e (patch)
tree2b9c586de5573bc73d089f27034488ef9f4f1972 /doc/GetIndex.3
parentde0e8e65020001b3fe87406d0cfa147c545e7b27 (diff)
downloadtcl-addc87417c54bb55b560b9afdf106e3ee0db660e.zip
tcl-addc87417c54bb55b560b9afdf106e3ee0db660e.tar.gz
tcl-addc87417c54bb55b560b9afdf106e3ee0db660e.tar.bz2
* doc/GetIndex.3:
* generic/tcl.decls (Tcl_GetIndexFromObjStruct): * generic/tclIndexObj.c (Tcl_GetIndexFromObjStruct): Revised the prototype of the Tcl_GetIndexFromObjStruct to take its struct table as a (CONST VOID *) argument, better describing what it is, maintaining source compatibility, and adding CONST correctness according to TIP 27. Thanks to Joe English for an elegant solution. [Bug 520304] * generic/tclDecls.h: make genstubs FossilOrigin-Name: 62ef0de80a34d56fca2eb4aa0d0588889b4c0226
Diffstat (limited to 'doc/GetIndex.3')
-rw-r--r--doc/GetIndex.312
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/GetIndex.3 b/doc/GetIndex.3
index 79d3a1e..8ac4975 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.9 2002/02/15 14:28:47 dkf Exp $
+'\" RCS: @(#) $Id: GetIndex.3,v 1.10 2002/02/28 05:11:25 dgp Exp $
'\"
.so man.macros
.TH Tcl_GetIndexFromObj 3 8.1 Tcl "Tcl Library Procedures"
@@ -21,7 +21,7 @@ indexPtr\fR)
.VS
.sp
int
-\fBTcl_GetIndexFromObjStruct\fR(\fIinterp, objPtr, tablePtr, offset,
+\fBTcl_GetIndexFromObjStruct\fR(\fIinterp, objPtr, structTablePtr, offset,
msg, flags, indexPtr\fR)
.VE
.SH ARGUMENTS
@@ -36,10 +36,14 @@ table entry.
.AP "CONST char" **tablePtr in
An array of null-terminated ASCII strings. The end of the array is marked
by a NULL string pointer.
+.AP "CONST VOID" *structTablePtr in
+An array of arbitrary type, typically some \fBstruct\fP type.
+The first member of the structure must be a null-terminated ASCII string.
+The size of the structure is given by \fIoffset\fP.
.VS
.AP int offset in
-The offset to add to tablePtr to get to the next string in the
-list. The end of the array is marked by a NULL string pointer.
+The offset to add to structTablePtr to get to the next entry.
+The end of the array is marked by a NULL string pointer.
.VE
.AP "CONST char" *msg in
Null-terminated string describing what is being looked up, such as