diff options
Diffstat (limited to 'doc/GetIndex.3')
| -rw-r--r-- | doc/GetIndex.3 | 39 |
1 files changed, 18 insertions, 21 deletions
diff --git a/doc/GetIndex.3 b/doc/GetIndex.3 index e47f89b..82590fb 100644 --- a/doc/GetIndex.3 +++ b/doc/GetIndex.3 @@ -16,14 +16,12 @@ Tcl_GetIndexFromObj, Tcl_GetIndexFromObjStruct \- lookup string in table of keyw int \fBTcl_GetIndexFromObj\fR(\fIinterp, objPtr, tablePtr, msg, flags, indexPtr\fR) -.VS .sp int \fBTcl_GetIndexFromObjStruct\fR(\fIinterp, objPtr, structTablePtr, offset, -msg, flags, indexPtr\fR) -.VE + msg, flags, indexPtr\fR) .SH ARGUMENTS -.AS "CONST char" **tablePtr +.AS "const char" *structTablePtr in/out .AP Tcl_Interp *interp in Interpreter to use for error reporting; if NULL, then no message is provided on errors. @@ -31,19 +29,17 @@ provided on errors. The string value of this object is used to search through \fItablePtr\fR. The internal representation is modified to hold the index of the matching table entry. -.AP "CONST char" **tablePtr in +.AP "const char" **tablePtr in An array of null-terminated 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. +.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\fP. -.VS +The size of the structure is given by \fIoffset\fR. .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. -.VE -.AP "CONST char" *msg in +.AP "const char" *msg in Null-terminated string describing what is being looked up, such as \fBoption\fR. This string is included in error messages. .AP int flags in @@ -66,14 +62,14 @@ 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 -result if \fIinterp\fR isn't NULL. \fIMsg\fR is included in the +\fBTCL_ERROR\fR is returned and an error message is left in \fIinterp\fR's +result if \fIinterp\fR is not 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 -\fBbad option "firt": must be first, second, or third\fR. +.QW "\fBbad option \N'34'firt\N'34': must be first, second, or third\fR" . .PP If \fBTcl_GetIndexFromObj\fR completes successfully it modifies the internal representation of \fIobjPtr\fR to hold the address of @@ -85,17 +81,18 @@ 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. -.VS +and return \fBTCL_ERROR\fR. .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 .SH "SEE ALSO" Tcl_WrongNumArgs |