Subversion Repositories or1k

'\"

'\" Copyright (c) 1989-1993 The Regents of the University of California.

'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.

'\"

'\" 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.1.1.1 2002-01-16 10:25:24 markom Exp $

'\"

.so man.macros

.TH Tcl_StringMatch 3 "" Tcl "Tcl Library Procedures"

.BS

.SH NAME

Tcl_StringMatch \- test whether a string matches a pattern

.SH SYNOPSIS

.nf

\fB#include \fR

.sp

int

\fBTcl_StringMatch\fR(\fIstring\fR, \fIpattern\fR)

.SH ARGUMENTS

.AP char *string in

String to test.

.AP char *pattern in

Pattern to match against string.  May contain special

characters from the set *?\e[].

.BE

.SH DESCRIPTION

.PP

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''

Tcl command and is similar to the algorithm used by the C-shell

for file name matching;  see the Tcl manual entry for details.

.SH KEYWORDS

match, pattern, string