<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Apache Portable Runtime: Filename Matching Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache Portable Runtime
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Filename Matching Functions<div class="ingroups"><a class="el" href="group___a_p_r.html">Apache Portability Runtime library</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaea769621807400e4c741e7deddf6c3df"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__fnmatch.html#gaea769621807400e4c741e7deddf6c3df">APR_FNM_NOMATCH</a>   1</td></tr>
<tr class="separator:gaea769621807400e4c741e7deddf6c3df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae12c1286631f316647be6dc007170630"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__fnmatch.html#gae12c1286631f316647be6dc007170630">APR_FNM_NOESCAPE</a>   0x01</td></tr>
<tr class="separator:gae12c1286631f316647be6dc007170630"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0d421a2cef68cb590f958b5de6c7fe1b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__fnmatch.html#ga0d421a2cef68cb590f958b5de6c7fe1b">APR_FNM_PATHNAME</a>   0x02</td></tr>
<tr class="separator:ga0d421a2cef68cb590f958b5de6c7fe1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4806f936b6eacc59dfed831d67b750ef"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__fnmatch.html#ga4806f936b6eacc59dfed831d67b750ef">APR_FNM_PERIOD</a>   0x04</td></tr>
<tr class="separator:ga4806f936b6eacc59dfed831d67b750ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5cee1c0a917a283a193721d11160b502"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__fnmatch.html#ga5cee1c0a917a283a193721d11160b502">APR_FNM_CASE_BLIND</a>   0x08</td></tr>
<tr class="separator:ga5cee1c0a917a283a193721d11160b502"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gabe9c7d7efe6afc203a01befbc45bad96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__fnmatch.html#gabe9c7d7efe6afc203a01befbc45bad96">apr_fnmatch</a> (const char *pattern, const char *strings, int flags)</td></tr>
<tr class="separator:gabe9c7d7efe6afc203a01befbc45bad96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4e7828bb7be756d999f13b8af8202204"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__fnmatch.html#ga4e7828bb7be756d999f13b8af8202204">apr_fnmatch_test</a> (const char *pattern)</td></tr>
<tr class="separator:ga4e7828bb7be756d999f13b8af8202204"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaba55810d3e241b61b9f47f23231e3a02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__fnmatch.html#gaba55810d3e241b61b9f47f23231e3a02">apr_match_glob</a> (const char *pattern, <a class="el" href="structapr__array__header__t.html">apr_array_header_t</a> **result, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p)</td></tr>
<tr class="separator:gaba55810d3e241b61b9f47f23231e3a02"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga5cee1c0a917a283a193721d11160b502"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FNM_CASE_BLIND   0x08</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compare characters case-insensitively. </p>
<dl class="section remark"><dt>Remarks</dt><dd>This flag is an Apache addition </dd></dl>
</div>
</div>
<a class="anchor" id="gae12c1286631f316647be6dc007170630"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FNM_NOESCAPE   0x01</td>
</tr>
</table>
</div><div class="memdoc">
<p>Disable backslash escaping. </p>
</div>
</div>
<a class="anchor" id="gaea769621807400e4c741e7deddf6c3df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FNM_NOMATCH   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Match failed. </p>
</div>
</div>
<a class="anchor" id="ga0d421a2cef68cb590f958b5de6c7fe1b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FNM_PATHNAME   0x02</td>
</tr>
</table>
</div><div class="memdoc">
<p>Slash must be matched by slash. </p>
</div>
</div>
<a class="anchor" id="ga4806f936b6eacc59dfed831d67b750ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FNM_PERIOD   0x04</td>
</tr>
</table>
</div><div class="memdoc">
<p>Period must be matched by period. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gabe9c7d7efe6afc203a01befbc45bad96"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_fnmatch </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>strings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Try to match the string to the given pattern, return APR_SUCCESS if match, else return APR_FNM_NOMATCH. Note that there is no such thing as an illegal pattern.</p>
<p>With all flags unset, a pattern is interpreted as such:</p>
<p>PATTERN: Backslash followed by any character, including another backslash.<br/>
MATCHES: That character exactly.</p>
<p>PATTERN: ?<br/>
MATCHES: Any single character. </p>
<p>PATTERN: *<br/>
MATCHES: Any sequence of zero or more characters. (Note that multiple *s in a row are equivalent to one.)</p>
<p>PATTERN: Any character other than \?*[ or a \ at the end of the pattern<br/>
MATCHES: That character exactly. (Case sensitive.)</p>
<p>PATTERN: [ followed by a class description followed by ]<br/>
MATCHES: A single character described by the class description. (Never matches, if the class description reaches until the end of the string without a ].) If the first character of the class description is ^ or !, the sense of the description is reversed. The rest of the class description is a list of single characters or pairs of characters separated by -. Any of those characters can have a backslash in front of them, which is ignored; this lets you use the characters ] and - in the character class, as well as ^ and ! at the beginning. The pattern matches a single character if it is one of the listed characters or falls into one of the listed ranges (inclusive, case sensitive). Ranges with the first character larger than the second are legal but never match. Edge cases: [] never matches, and [^] and [!] always match without consuming a character.</p>
<p>Note that these patterns attempt to match the entire string, not just find a substring matching the pattern.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pattern</td><td>The pattern to match to </td></tr>
<tr><td class="paramname">strings</td><td>The string we are trying to match </td></tr>
<tr><td class="paramname">flags</td><td>flags to use in the match. Bitwise OR of: <pre>
APR_FNM_NOESCAPE Disable backslash escaping
APR_FNM_PATHNAME Slash must be matched by slash
APR_FNM_PERIOD Period must be matched by period
APR_FNM_CASE_BLIND Compare characters case-insensitively.
</pre> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga4e7828bb7be756d999f13b8af8202204"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int apr_fnmatch_test </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pattern</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine if the given pattern is a regular expression. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pattern</td><td>The pattern to search for glob characters. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>non-zero if pattern has any glob characters in it </dd></dl>
</div>
</div>
<a class="anchor" id="gaba55810d3e241b61b9f47f23231e3a02"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_match_glob </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structapr__array__header__t.html">apr_array_header_t</a> ** </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find all files that match a specified pattern. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pattern</td><td>The pattern to use for finding files. </td></tr>
<tr><td class="paramname">result</td><td>Array to use when storing the results </td></tr>
<tr><td class="paramname">p</td><td>The pool to use. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>non-zero if pattern has any glob characters in it </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Nov 30 2013 15:32:17 for Apache Portable Runtime by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
