Standard C Library Functions fnmatch(3C)
NAME
fnmatch - match filename or path name
SYNOPSIS
#include
int fnmatch(const char *pattern, const char *string, int flags);
DESCRIPTION
The fnmatch() function matches patterns as described on the
fnmatch(5) manual page. It checks the string argument to
see if it matches the pattern argument.
The flags argument modifies the interpretation of pattern
and string. It is the bitwise inclusive OR of zero or more
of the following flags defined in the header .
FNMPATHNAME If set, a slash (/) character in string
will be explicitly matched by a slash in
pattern; it will not be matched by either
the asterisk (*) or question-mark (?) spe-
cial characters, nor by a bracket ([])
expression.
If not set, the slash character is treated
as an ordinary character.
FNMNOESCAPE If not set, a backslash character (\) in
pattern followed by any other character
will match that second character in
string. In particular, "\\" will match a
backslash in string.
If set, a backslash character will be
treated as an ordinary character.
FNMPERIOD If set, a leading period in string will
match a period in pattern; where the loca-
tion of "leading" is indicated by the
value of FNMPATHNAME:
o If FNMPATHNAME is set, a period
is "leading" if it is the first
character in string or if it
immediately follows a slash.
o If FNMPATHNAME is not set, a
period is "leading" only if it is
SunOS 5.11 Last change: 24 Jul 2002 1
Standard C Library Functions fnmatch(3C)
the first character of string.
If not set, no special restrictions are placed on matching a
period.
RETURN VALUES
If string matches the pattern specified by pattern, then
fnmatch() returns 0. If there is no match, fnmatch() returns
FNMNOMATCH, which is defined in the header . If
an error occurs, fnmatch() returns another non-zero value.
USAGE
The fnmatch() function has two major uses. It could be used
by an application or utility that needs to read a directory
and apply a pattern against each entry. The find(1) utility
is an example of this. It can also be used by the pax(1)
utility to process its pattern operands, or by applications
that need to match strings in a similar manner.
The name fnmatch() is intended to imply filename match,
rather than pathname match. The default action of this func-
tion is to match filenames, rather than path names, since it
gives no special significance to the slash character. With
the FNMPATHNAME flag, fnmatch() does match path names, but
without tilde expansion, parameter expansion, or special
treatment for period at the beginning of a filename.
The fnmatch() function can be used safely in multithreaded
applications, as long as setlocale(3C) is not being called
to change the locale.
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SunOS 5.11 Last change: 24 Jul 2002 2
Standard C Library Functions fnmatch(3C)
ATRIBUTE TYPE ATRIBUTE VALUE
CSI Enabled
Interface Stability Standard
MT-Level MT-Safe with exceptions
SEE ALSO
find(1), pax(1), glob(3C), setlocale(3C), wordexp(3C),
attributes(5), fnmatch(5), standards(5)
SunOS 5.11 Last change: 24 Jul 2002 3
|
