<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Portable Runtime: Filepath Manipulation 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" 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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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">Filepath Manipulation Functions<div class="ingroups"><a class="el" href="group___a_p_r.html">Apache Portability Runtime library</a> » <a class="el" href="group__apr__file__info.html">File Information</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:gabb57ce7b23caf512d7f64b92a662ab3d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__filepath.html#gabb57ce7b23caf512d7f64b92a662ab3d">APR_FILEPATH_NOTABOVEROOT</a>   0x01</td></tr>
<tr class="separator:gabb57ce7b23caf512d7f64b92a662ab3d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga48b6cabfa91e6070c45977ba7035f328"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__filepath.html#ga48b6cabfa91e6070c45977ba7035f328">APR_FILEPATH_SECUREROOTTEST</a>   0x02</td></tr>
<tr class="separator:ga48b6cabfa91e6070c45977ba7035f328"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6a518889311b81e1d2fc434e7d3acecd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__filepath.html#ga6a518889311b81e1d2fc434e7d3acecd">APR_FILEPATH_SECUREROOT</a>   0x03</td></tr>
<tr class="separator:ga6a518889311b81e1d2fc434e7d3acecd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga487344eb474ea4033b19c386db9aa03a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__filepath.html#ga487344eb474ea4033b19c386db9aa03a">APR_FILEPATH_NOTRELATIVE</a>   0x04</td></tr>
<tr class="separator:ga487344eb474ea4033b19c386db9aa03a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaac75b8e9fd5c248b52ac36a1fd6b7f98"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__filepath.html#gaac75b8e9fd5c248b52ac36a1fd6b7f98">APR_FILEPATH_NOTABSOLUTE</a>   0x08</td></tr>
<tr class="separator:gaac75b8e9fd5c248b52ac36a1fd6b7f98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2d72ade2cada76d2fa8af3fe4d8fb1de"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__filepath.html#ga2d72ade2cada76d2fa8af3fe4d8fb1de">APR_FILEPATH_NATIVE</a>   0x10</td></tr>
<tr class="separator:ga2d72ade2cada76d2fa8af3fe4d8fb1de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafb7dd411e9ef212a03051806cb60c9d8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__filepath.html#gafb7dd411e9ef212a03051806cb60c9d8">APR_FILEPATH_TRUENAME</a>   0x20</td></tr>
<tr class="separator:gafb7dd411e9ef212a03051806cb60c9d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga26cd6345ccc38ae3ad001fd2fa885634"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__filepath.html#ga26cd6345ccc38ae3ad001fd2fa885634">APR_FILEPATH_ENCODING_UNKNOWN</a>   0</td></tr>
<tr class="separator:ga26cd6345ccc38ae3ad001fd2fa885634"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaecb3193c8e36fbf58564f94b8c38b6d9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__filepath.html#gaecb3193c8e36fbf58564f94b8c38b6d9">APR_FILEPATH_ENCODING_LOCALE</a>   1</td></tr>
<tr class="separator:gaecb3193c8e36fbf58564f94b8c38b6d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1c99d1644a8b49dc0be166bdc352819a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__filepath.html#ga1c99d1644a8b49dc0be166bdc352819a">APR_FILEPATH_ENCODING_UTF8</a>   2</td></tr>
<tr class="separator:ga1c99d1644a8b49dc0be166bdc352819a"><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:ga1eacdd5ed069faa137bde014fa50494d"><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__filepath.html#ga1eacdd5ed069faa137bde014fa50494d">apr_filepath_root</a> (const char **rootpath, const char **filepath, apr_int32_t flags, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p)</td></tr>
<tr class="separator:ga1eacdd5ed069faa137bde014fa50494d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae89fd67108f10dc5044b6d062dde0138"><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__filepath.html#gae89fd67108f10dc5044b6d062dde0138">apr_filepath_merge</a> (char **newpath, const char *rootpath, const char *addpath, apr_int32_t flags, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p)</td></tr>
<tr class="separator:gae89fd67108f10dc5044b6d062dde0138"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf259849de62ac172dde7dcbe73421500"><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__filepath.html#gaf259849de62ac172dde7dcbe73421500">apr_filepath_list_split</a> (<a class="el" href="structapr__array__header__t.html">apr_array_header_t</a> **pathelts, const char *liststr, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p)</td></tr>
<tr class="separator:gaf259849de62ac172dde7dcbe73421500"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8316896ab8e3901f9711d9d4cc89b373"><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__filepath.html#ga8316896ab8e3901f9711d9d4cc89b373">apr_filepath_list_merge</a> (char **liststr, <a class="el" href="structapr__array__header__t.html">apr_array_header_t</a> *pathelts, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p)</td></tr>
<tr class="separator:ga8316896ab8e3901f9711d9d4cc89b373"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaac7c26321fd60d7304326fe531639507"><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__filepath.html#gaac7c26321fd60d7304326fe531639507">apr_filepath_get</a> (char **path, apr_int32_t flags, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p)</td></tr>
<tr class="separator:gaac7c26321fd60d7304326fe531639507"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9773589b65b7f0b7d5b59d427fd0eb93"><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__filepath.html#ga9773589b65b7f0b7d5b59d427fd0eb93">apr_filepath_set</a> (const char *path, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p)</td></tr>
<tr class="separator:ga9773589b65b7f0b7d5b59d427fd0eb93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad4d3a5888a54a52b3552911e448a3eb3"><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__filepath.html#gad4d3a5888a54a52b3552911e448a3eb3">apr_filepath_encoding</a> (int *style, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p)</td></tr>
<tr class="separator:gad4d3a5888a54a52b3552911e448a3eb3"><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 id="gaecb3193c8e36fbf58564f94b8c38b6d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaecb3193c8e36fbf58564f94b8c38b6d9">◆ </a></span>APR_FILEPATH_ENCODING_LOCALE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FILEPATH_ENCODING_LOCALE   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>The FilePath character encoding is locale-dependent </p>
</div>
</div>
<a id="ga26cd6345ccc38ae3ad001fd2fa885634"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga26cd6345ccc38ae3ad001fd2fa885634">◆ </a></span>APR_FILEPATH_ENCODING_UNKNOWN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FILEPATH_ENCODING_UNKNOWN   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>The FilePath character encoding is unknown </p>
</div>
</div>
<a id="ga1c99d1644a8b49dc0be166bdc352819a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1c99d1644a8b49dc0be166bdc352819a">◆ </a></span>APR_FILEPATH_ENCODING_UTF8</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FILEPATH_ENCODING_UTF8   2</td>
</tr>
</table>
</div><div class="memdoc">
<p>The FilePath character encoding is UTF-8 </p>
</div>
</div>
<a id="ga2d72ade2cada76d2fa8af3fe4d8fb1de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2d72ade2cada76d2fa8af3fe4d8fb1de">◆ </a></span>APR_FILEPATH_NATIVE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FILEPATH_NATIVE   0x10</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the file system's native path format (e.g. path delimiters of ':' on MacOS9, '\' on Win32, etc.) </p>
</div>
</div>
<a id="gabb57ce7b23caf512d7f64b92a662ab3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabb57ce7b23caf512d7f64b92a662ab3d">◆ </a></span>APR_FILEPATH_NOTABOVEROOT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FILEPATH_NOTABOVEROOT   0x01</td>
</tr>
</table>
</div><div class="memdoc">
<p>Cause apr_filepath_merge to fail if addpath is above rootpath </p><dl class="bug"><dt><b><a class="el" href="bug.html#_bug000002">Bug:</a></b></dt><dd>in APR 0.9 and 1.x, this flag's behavior is undefined if the rootpath is NULL or empty. In APR 2.0 this should be changed to imply NOTABSOLUTE if the rootpath is NULL or empty. </dd></dl>
</div>
</div>
<a id="gaac75b8e9fd5c248b52ac36a1fd6b7f98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaac75b8e9fd5c248b52ac36a1fd6b7f98">◆ </a></span>APR_FILEPATH_NOTABSOLUTE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FILEPATH_NOTABSOLUTE   0x08</td>
</tr>
</table>
</div><div class="memdoc">
<p>Fail apr_filepath_merge if the merged path is absolute </p>
</div>
</div>
<a id="ga487344eb474ea4033b19c386db9aa03a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga487344eb474ea4033b19c386db9aa03a">◆ </a></span>APR_FILEPATH_NOTRELATIVE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FILEPATH_NOTRELATIVE   0x04</td>
</tr>
</table>
</div><div class="memdoc">
<p>Fail apr_filepath_merge if the merged path is relative </p>
</div>
</div>
<a id="ga6a518889311b81e1d2fc434e7d3acecd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6a518889311b81e1d2fc434e7d3acecd">◆ </a></span>APR_FILEPATH_SECUREROOT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FILEPATH_SECUREROOT   0x03</td>
</tr>
</table>
</div><div class="memdoc">
<p>Cause apr_filepath_merge to fail if addpath is above rootpath, even given a rootpath /foo/bar and an addpath ../bar/bash </p>
</div>
</div>
<a id="ga48b6cabfa91e6070c45977ba7035f328"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga48b6cabfa91e6070c45977ba7035f328">◆ </a></span>APR_FILEPATH_SECUREROOTTEST</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FILEPATH_SECUREROOTTEST   0x02</td>
</tr>
</table>
</div><div class="memdoc">
<p>internal: Only meaningful with APR_FILEPATH_NOTABOVEROOT </p>
</div>
</div>
<a id="gafb7dd411e9ef212a03051806cb60c9d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafb7dd411e9ef212a03051806cb60c9d8">◆ </a></span>APR_FILEPATH_TRUENAME</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FILEPATH_TRUENAME   0x20</td>
</tr>
</table>
</div><div class="memdoc">
<p>Resolve the true case of existing directories and file elements of addpath, (resolving any aliases on Win32) and append a proper trailing slash if a directory </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad4d3a5888a54a52b3552911e448a3eb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad4d3a5888a54a52b3552911e448a3eb3">◆ </a></span>apr_filepath_encoding()</h2>
<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_filepath_encoding </td>
<td>(</td>
<td class="paramtype">int * </td>
<td class="paramname"><em>style</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>Determine the encoding used internally by the FilePath functions </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">style</td><td>points to a variable which receives the encoding style flag </td></tr>
<tr><td class="paramname">p</td><td>the pool to allocate any working storage </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>Use <code>apr_os_locale_encoding</code> and/or <code>apr_os_default_encoding</code> to get the name of the path encoding if it's not UTF-8. </dd></dl>
</div>
</div>
<a id="gaac7c26321fd60d7304326fe531639507"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaac7c26321fd60d7304326fe531639507">◆ </a></span>apr_filepath_get()</h2>
<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_filepath_get </td>
<td>(</td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_int32_t </td>
<td class="paramname"><em>flags</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>Return the default file path (for relative file names) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>the default path string returned </td></tr>
<tr><td class="paramname">flags</td><td>optional flag APR_FILEPATH_NATIVE to retrieve the default file path in os-native format. </td></tr>
<tr><td class="paramname">p</td><td>the pool to allocate the default path string from </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga8316896ab8e3901f9711d9d4cc89b373"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8316896ab8e3901f9711d9d4cc89b373">◆ </a></span>apr_filepath_list_merge()</h2>
<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_filepath_list_merge </td>
<td>(</td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>liststr</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>pathelts</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>Merge a list of search path components into a single search path </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">liststr</td><td>the returned search path; may be NULL if <em>pathelts</em> is empty </td></tr>
<tr><td class="paramname">pathelts</td><td>the components of the search path </td></tr>
<tr><td class="paramname">p</td><td>the pool to allocate the search path from </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>emtpy strings in the source array are ignored. </dd>
<dd>
the path separator in <em>liststr</em> is system specific; e.g., ':' on Unix, ';' on Windows, etc. </dd></dl>
</div>
</div>
<a id="gaf259849de62ac172dde7dcbe73421500"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf259849de62ac172dde7dcbe73421500">◆ </a></span>apr_filepath_list_split()</h2>
<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_filepath_list_split </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>pathelts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>liststr</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>Split a search path into separate components </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pathelts</td><td>the returned components of the search path </td></tr>
<tr><td class="paramname">liststr</td><td>the search path (e.g., <code>getenv("PATH")</code>) </td></tr>
<tr><td class="paramname">p</td><td>the pool to allocate the array and path components from </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>empty path components do not become part of <em>pathelts</em>. </dd>
<dd>
the path separator in <em>liststr</em> is system specific; e.g., ':' on Unix, ';' on Windows, etc. </dd></dl>
</div>
</div>
<a id="gae89fd67108f10dc5044b6d062dde0138"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae89fd67108f10dc5044b6d062dde0138">◆ </a></span>apr_filepath_merge()</h2>
<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_filepath_merge </td>
<td>(</td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>newpath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>rootpath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>addpath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_int32_t </td>
<td class="paramname"><em>flags</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>Merge additional file path onto the previously processed rootpath </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">newpath</td><td>the merged paths returned </td></tr>
<tr><td class="paramname">rootpath</td><td>the root file path (NULL uses the current working path) </td></tr>
<tr><td class="paramname">addpath</td><td>the path to add to the root path </td></tr>
<tr><td class="paramname">flags</td><td>the desired APR_FILEPATH_ rules to apply when merging </td></tr>
<tr><td class="paramname">p</td><td>the pool to allocate the new path string from </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>if the flag APR_FILEPATH_TRUENAME is given, and the addpath contains wildcard characters ('*', '?') on platforms that don't support such characters within filenames, the paths will be merged, but the result code will be APR_EPATHWILD, and all further segments will not reflect the true filenames including the wildcard and following segments. </dd></dl>
</div>
</div>
<a id="ga1eacdd5ed069faa137bde014fa50494d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1eacdd5ed069faa137bde014fa50494d">◆ </a></span>apr_filepath_root()</h2>
<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_filepath_root </td>
<td>(</td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>rootpath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>filepath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_int32_t </td>
<td class="paramname"><em>flags</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>Extract the rootpath from the given filepath </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rootpath</td><td>the root file path returned with APR_SUCCESS or APR_EINCOMPLETE </td></tr>
<tr><td class="paramname">filepath</td><td>the pathname to parse for its root component </td></tr>
<tr><td class="paramname">flags</td><td>the desired rules to apply, from <pre>
APR_FILEPATH_NATIVE Use native path separators (e.g. '\' on Win32)
APR_FILEPATH_TRUENAME Tests that the root exists, and makes it proper
</pre> </td></tr>
<tr><td class="paramname">p</td><td>the pool to allocate the new path string from </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>on return, filepath points to the first non-root character in the given filepath. In the simplest example, given a filepath of "/foo", returns the rootpath of "/" and filepath points at "foo". This is far more complex on other platforms, which will canonicalize the root form to a consistant format, given the APR_FILEPATH_TRUENAME flag, and also test for the validity of that root (e.g., that a drive d:/ or network share //machine/foovol/). The function returns APR_ERELATIVE if filepath isn't rooted (an error), APR_EINCOMPLETE if the root path is ambiguous (but potentially legitimate, e.g. "/" on Windows is incomplete because it doesn't specify the drive letter), or APR_EBADPATH if the root is simply invalid. APR_SUCCESS is returned if filepath is an absolute path. </dd></dl>
</div>
</div>
<a id="ga9773589b65b7f0b7d5b59d427fd0eb93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9773589b65b7f0b7d5b59d427fd0eb93">◆ </a></span>apr_filepath_set()</h2>
<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_filepath_set </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path</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>Set the default file path (for relative file names) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>the default path returned </td></tr>
<tr><td class="paramname">p</td><td>the pool to allocate any working storage </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
