diff options
author | dkf <donal.k.fellows@manchester.ac.uk> | 2012-07-04 07:09:40 (GMT) |
---|---|---|
committer | dkf <donal.k.fellows@manchester.ac.uk> | 2012-07-04 07:09:40 (GMT) |
commit | 9dee089fa2567d307056363c20eb69c53b4e1655 (patch) | |
tree | f601a0cf95af6e9aeea8f330063f37565515f418 /doc/GetIndex.3 | |
parent | 6de91b6b7d469c5f8d511700b75689df23e43fd1 (diff) | |
parent | d3104ac52bdca1849c62445954323c841fcd5009 (diff) | |
download | tcl-9dee089fa2567d307056363c20eb69c53b4e1655.zip tcl-9dee089fa2567d307056363c20eb69c53b4e1655.tar.gz tcl-9dee089fa2567d307056363c20eb69c53b4e1655.tar.bz2 |
merge trunk
Diffstat (limited to 'doc/GetIndex.3')
-rw-r--r-- | doc/GetIndex.3 | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/GetIndex.3 b/doc/GetIndex.3 index f60feb5..50607ae 100644 --- a/doc/GetIndex.3 +++ b/doc/GetIndex.3 @@ -32,10 +32,16 @@ table entry. .AP "const char *const" *tablePtr in An array of null-terminated strings. The end of the array is marked by a NULL string pointer. +Note that references to the \fItablePtr\fR may be retained in the +internal representation of \fIobjPtr\fR, so this should represent the +address of a statically-allocated array. .AP "const void" *structTablePtr in An array of arbitrary type, typically some \fBstruct\fR type. The first member of the structure must be a null-terminated string. The size of the structure is given by \fIoffset\fR. +Note that references to the \fIstructTablePtr\fR may be retained in the +internal representation of \fIobjPtr\fR, so this should represent the +address of a statically-allocated array of structures. .AP int offset in The offset to add to structTablePtr to get to the next entry. The end of the array is marked by a NULL string pointer. @@ -51,10 +57,10 @@ The index of the string in \fItablePtr\fR that matches the value of .BE .SH DESCRIPTION .PP -This procedure provides an efficient way for looking up keywords, +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. -\fIObjPtr\fR is compared against each of +\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 \fItablePtr\fR, or if it is a non-empty unique abbreviation |