Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tcl_StringMatch (3tcl)

Name

Tcl_StringMatch - test whether a string matches a pattern

Synopsis

#include <tcl.h>

int
Tcl_StringMatch(str, pattern)

int
Tcl_StringCaseMatch(str, pattern, flags)

Description

Tcl_StringMatch(3tcl)       Tcl Library Procedures       Tcl_StringMatch(3tcl)



______________________________________________________________________________

NAME
       Tcl_StringMatch,  Tcl_StringCaseMatch - test whether a string matches a
       pattern

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 pat-
       tern.    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 man-
       ual 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



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | runtime/tcl-8    |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source was downloaded from  http://prdownloads.sourceforge.net/tcl/tcl-
       core8.6.7-src.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.tcl.tk/.



Tcl                                   8.5                Tcl_StringMatch(3tcl)