diff options
Diffstat (limited to 'doc/StrMatch.3')
| -rw-r--r-- | doc/StrMatch.3 | 26 |
1 files changed, 18 insertions, 8 deletions
diff --git a/doc/StrMatch.3 b/doc/StrMatch.3 index 09cd6df..f9c2be3 100644 --- a/doc/StrMatch.3 +++ b/doc/StrMatch.3 @@ -5,25 +5,30 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: StrMatch.3,v 1.2 1998/09/14 18:39:50 stanton Exp $ -'\" +.TH Tcl_StringMatch 3 8.5 Tcl "Tcl Library Procedures" .so man.macros -.TH Tcl_StringMatch 3 "" Tcl "Tcl Library Procedures" .BS .SH NAME -Tcl_StringMatch \- test whether a string matches a pattern +Tcl_StringMatch, Tcl_StringCaseMatch \- test whether a string matches a pattern .SH SYNOPSIS .nf \fB#include <tcl.h>\fR .sp int -\fBTcl_StringMatch\fR(\fIstring\fR, \fIpattern\fR) +\fBTcl_StringMatch\fR(\fIstr\fR, \fIpattern\fR) +.sp +int +\fBTcl_StringCaseMatch\fR(\fIstr\fR, \fIpattern\fR, \fIflags\fR) .SH ARGUMENTS -.AP char *string in +.AS "const char" *pattern +.AP "const char" *str in String to test. -.AP char *pattern in +.AP "const char" *pattern in Pattern to match against string. May contain special characters from the set *?\e[]. +.AP int flags in +OR-ed combination of match flags, currently only \fBTCL_MATCH_NOCASE\fR. +0 specifies a case-sensitive search. .BE .SH DESCRIPTION @@ -31,9 +36,14 @@ characters from the set *?\e[]. This utility procedure determines whether a string matches a given pattern. If it does, then \fBTcl_StringMatch\fR returns 1. Otherwise \fBTcl_StringMatch\fR returns 0. The algorithm -used for matching is the same algorithm used in the ``string match'' +used for matching is the same algorithm used in the \fBstring match\fR Tcl command and is similar to the algorithm used by the C-shell for file name matching; see the Tcl manual entry for details. +.PP +In \fBTcl_StringCaseMatch\fR, the algorithm is +the same, but you have the option to make the matching case-insensitive. +If you choose this (by passing \fBTCL_MATCH_NOCASE\fR), then the string and +pattern are essentially matched in the lower case. .SH KEYWORDS match, pattern, string |