tcldoc Tcl/Tk 9.0.4
/

Home › Tcl Library Procedures Tcl

Tcl_StringMatch C API

Test whether a string matches a pattern

Also documents Tcl_StringCaseMatch

literal type exactly as shown argument replace with your value ?optional? may be omitted

Synopsis#

#include <tcl.h>

int Tcl_StringMatch(str, pattern)#

int Tcl_StringCaseMatch(str, pattern, flags)#

Arguments#

const char *str (in)

String to test.

const char *pattern (in)

Pattern to match against string. May contain special characters from the set *?\[].

int flags (in)

OR-ed combination of match flags, currently only TCL_MATCH_NOCASE. 0 specifies a case-sensitive search.

Description#

This utility procedure determines whether a string matches a given pattern. If it does, then Tcl_StringMatch returns 1. Otherwise Tcl_StringMatch 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.

In Tcl_StringCaseMatch, the algorithm is the same, but you have the option to make the matching case-insensitive. If you choose this (by passing TCL_MATCH_NOCASE), then the string and pattern are essentially matched in the lower case.

Keywords#

match · pattern · string

Copyright#