<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>Apache Portable Runtime: apr_file_info.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.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)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>apr_file_info.h</h1><a href="apr__file__info_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span>
<a name="l00002"></a>00002 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
<a name="l00003"></a>00003 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
<a name="l00004"></a>00004 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
<a name="l00005"></a>00005 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
<a name="l00006"></a>00006 <span class="comment"> * the License. You may obtain a copy of the License at</span>
<a name="l00007"></a>00007 <span class="comment"> *</span>
<a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"> */</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef APR_FILE_INFO_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APR_FILE_INFO_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment">/**</span>
<a name="l00021"></a>00021 <span class="comment"> * @file apr_file_info.h</span>
<a name="l00022"></a>00022 <span class="comment"> * @brief APR File Information</span>
<a name="l00023"></a>00023 <span class="comment"> */</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="apr_8h.html" title="APR Platform Definitions.">apr.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="apr__user_8h.html" title="APR User ID Services.">apr_user.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html" title="APR memory allocation.">apr_pools.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="apr__tables_8h.html" title="APR Table library.">apr_tables.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="apr__time_8h.html" title="APR Time Library.">apr_time.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html" title="APR Error Codes.">apr_errno.h</a>"</span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="preprocessor">#if APR_HAVE_SYS_UIO_H</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#include <sys/uio.h></span>
<a name="l00034"></a>00034 <span class="preprocessor">#endif</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00036"></a>00036 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00038"></a>00038 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
<a name="l00039"></a>00039 <span class="comment"></span>
<a name="l00040"></a>00040 <span class="comment">/**</span>
<a name="l00041"></a>00041 <span class="comment"> * @defgroup apr_file_info File Information</span>
<a name="l00042"></a>00042 <span class="comment"> * @ingroup APR </span>
<a name="l00043"></a>00043 <span class="comment"> * @{</span>
<a name="l00044"></a>00044 <span class="comment"> */</span>
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="comment">/* Many applications use the type member to determine the</span>
<a name="l00047"></a>00047 <span class="comment"> * existance of a file or initialization of the file info,</span>
<a name="l00048"></a>00048 <span class="comment"> * so the APR_NOFILE value must be distinct from APR_UNKFILE.</span>
<a name="l00049"></a>00049 <span class="comment"> */</span>
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment">/** apr_filetype_e values for the filetype member of the </span>
<a name="l00052"></a>00052 <span class="comment"> * apr_file_info_t structure</span>
<a name="l00053"></a>00053 <span class="comment"> * @warning: Not all of the filetypes below can be determined.</span>
<a name="l00054"></a>00054 <span class="comment"> * For example, a given platform might not correctly report </span>
<a name="l00055"></a>00055 <span class="comment"> * a socket descriptor as APR_SOCK if that type isn't </span>
<a name="l00056"></a>00056 <span class="comment"> * well-identified on that platform. In such cases where</span>
<a name="l00057"></a>00057 <span class="comment"> * a filetype exists but cannot be described by the recognized</span>
<a name="l00058"></a>00058 <span class="comment"> * flags below, the filetype will be APR_UNKFILE. If the</span>
<a name="l00059"></a>00059 <span class="comment"> * filetype member is not determined, the type will be APR_NOFILE.</span>
<a name="l00060"></a>00060 <span class="comment"> */</span>
<a name="l00061"></a>00061
<a name="l00062"></a><a class="code" href="group__apr__file__info.html#gae3f0ce3014337a52b39852f8bf81ca7c">00062</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00063"></a><a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7cae5877c29ba5fd483edbde0c51c0ac5e9">00063</a> <a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7cae5877c29ba5fd483edbde0c51c0ac5e9">APR_NOFILE</a> = 0, <span class="comment">/**< no file type determined */</span>
<a name="l00064"></a><a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7ca9a2849ad21618c937683c1ffe13a6257">00064</a> <a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7ca9a2849ad21618c937683c1ffe13a6257">APR_REG</a>, <span class="comment">/**< a regular file */</span>
<a name="l00065"></a><a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7cae2ee810fa994ae64b8fcc6b68d3ae540">00065</a> <a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7cae2ee810fa994ae64b8fcc6b68d3ae540">APR_DIR</a>, <span class="comment">/**< a directory */</span>
<a name="l00066"></a><a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7cadb769ffbe8659cbecf7ebf376d098d37">00066</a> <a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7cadb769ffbe8659cbecf7ebf376d098d37">APR_CHR</a>, <span class="comment">/**< a character device */</span>
<a name="l00067"></a><a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7ca20ea6a09a69785a7cd19fd05243c1c8d">00067</a> <a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7ca20ea6a09a69785a7cd19fd05243c1c8d">APR_BLK</a>, <span class="comment">/**< a block device */</span>
<a name="l00068"></a><a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7ca247719668cd02286a6a0ed767c30ce77">00068</a> <a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7ca247719668cd02286a6a0ed767c30ce77">APR_PIPE</a>, <span class="comment">/**< a FIFO / pipe */</span>
<a name="l00069"></a><a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7ca2b55a6db64d814bf08d5a56b026a8176">00069</a> <a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7ca2b55a6db64d814bf08d5a56b026a8176">APR_LNK</a>, <span class="comment">/**< a symbolic link */</span>
<a name="l00070"></a><a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7cadd5d86c1e616fe159a7ec04e0ddc70db">00070</a> <a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7cadd5d86c1e616fe159a7ec04e0ddc70db">APR_SOCK</a>, <span class="comment">/**< a [unix domain] socket */</span>
<a name="l00071"></a><a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7ca3347d2110d62ce464ddf1ae38759e6b0">00071</a> <a class="code" href="group__apr__file__info.html#ggae3f0ce3014337a52b39852f8bf81ca7ca3347d2110d62ce464ddf1ae38759e6b0">APR_UNKFILE</a> = 127 <span class="comment">/**< a file of some other unknown type */</span>
<a name="l00072"></a>00072 } <a class="code" href="group__apr__file__info.html#gae3f0ce3014337a52b39852f8bf81ca7c">apr_filetype_e</a>;
<a name="l00073"></a>00073 <span class="comment"></span>
<a name="l00074"></a>00074 <span class="comment">/**</span>
<a name="l00075"></a>00075 <span class="comment"> * @defgroup apr_file_permissions File Permissions flags </span>
<a name="l00076"></a>00076 <span class="comment"> * @{</span>
<a name="l00077"></a>00077 <span class="comment"> */</span>
<a name="l00078"></a>00078
<a name="l00079"></a><a class="code" href="group__apr__file__permissions.html#ga67caebf5bbe4f3f4b6252a75e5ce066f">00079</a> <span class="preprocessor">#define APR_FPROT_USETID 0x8000 </span><span class="comment">/**< Set user id */</span>
<a name="l00080"></a><a class="code" href="group__apr__file__permissions.html#gaab6c4c2e7b95f4345c248c27b3f1a655">00080</a> <span class="preprocessor">#define APR_FPROT_UREAD 0x0400 </span><span class="comment">/**< Read by user */</span>
<a name="l00081"></a><a class="code" href="group__apr__file__permissions.html#ga50b985779b15fbfdae0758e98ffb92af">00081</a> <span class="preprocessor">#define APR_FPROT_UWRITE 0x0200 </span><span class="comment">/**< Write by user */</span>
<a name="l00082"></a><a class="code" href="group__apr__file__permissions.html#ga156e1374a4ef30e745340d8c20b36d03">00082</a> <span class="preprocessor">#define APR_FPROT_UEXECUTE 0x0100 </span><span class="comment">/**< Execute by user */</span>
<a name="l00083"></a>00083
<a name="l00084"></a><a class="code" href="group__apr__file__permissions.html#ga5fcf6746afdd4e9b8be6ceab6892a3f5">00084</a> <span class="preprocessor">#define APR_FPROT_GSETID 0x4000 </span><span class="comment">/**< Set group id */</span>
<a name="l00085"></a><a class="code" href="group__apr__file__permissions.html#ga5ad9b67b8008db3ffc56c3c2a65aa192">00085</a> <span class="preprocessor">#define APR_FPROT_GREAD 0x0040 </span><span class="comment">/**< Read by group */</span>
<a name="l00086"></a><a class="code" href="group__apr__file__permissions.html#gacecdc9f88b04c768150418688b786500">00086</a> <span class="preprocessor">#define APR_FPROT_GWRITE 0x0020 </span><span class="comment">/**< Write by group */</span>
<a name="l00087"></a><a class="code" href="group__apr__file__permissions.html#gab627bef3f9ceb84bbf00906eaeb12184">00087</a> <span class="preprocessor">#define APR_FPROT_GEXECUTE 0x0010 </span><span class="comment">/**< Execute by group */</span>
<a name="l00088"></a>00088
<a name="l00089"></a><a class="code" href="group__apr__file__permissions.html#ga989dbea02f779a5f20a643d7e4ee9952">00089</a> <span class="preprocessor">#define APR_FPROT_WSTICKY 0x2000 </span><span class="comment">/**< Sticky bit */</span>
<a name="l00090"></a><a class="code" href="group__apr__file__permissions.html#ga194718630250b0f0dd4be38c86dac717">00090</a> <span class="preprocessor">#define APR_FPROT_WREAD 0x0004 </span><span class="comment">/**< Read by others */</span>
<a name="l00091"></a><a class="code" href="group__apr__file__permissions.html#ga51692a9828f5b6288d89495378944260">00091</a> <span class="preprocessor">#define APR_FPROT_WWRITE 0x0002 </span><span class="comment">/**< Write by others */</span>
<a name="l00092"></a><a class="code" href="group__apr__file__permissions.html#ga760d69c09b38ddf1e0aff09362d8ce11">00092</a> <span class="preprocessor">#define APR_FPROT_WEXECUTE 0x0001 </span><span class="comment">/**< Execute by others */</span>
<a name="l00093"></a>00093
<a name="l00094"></a><a class="code" href="group__apr__file__permissions.html#gad3c65a67ee6eb12ecc6a33857397900b">00094</a> <span class="preprocessor">#define APR_FPROT_OS_DEFAULT 0x0FFF </span><span class="comment">/**< use OS's default permissions */</span>
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="comment">/* additional permission flags for apr_file_copy and apr_file_append */</span>
<a name="l00097"></a><a class="code" href="group__apr__file__permissions.html#gac08d4e868c7c9532f7c97c70556663dc">00097</a> <span class="preprocessor">#define APR_FPROT_FILE_SOURCE_PERMS 0x1000 </span><span class="comment">/**< Copy source file's permissions */</span>
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="comment">/* backcompat */</span>
<a name="l00100"></a><a class="code" href="group__apr__file__permissions.html#gafae6b531c08999345536cae5654d0d03">00100</a> <span class="preprocessor">#define APR_USETID APR_FPROT_USETID </span><span class="comment">/**< @deprecated @see APR_FPROT_USETID */</span>
<a name="l00101"></a><a class="code" href="group__apr__file__permissions.html#ga51dc87ecd94c98e97694e68d5d9620a0">00101</a> <span class="preprocessor">#define APR_UREAD APR_FPROT_UREAD </span><span class="comment">/**< @deprecated @see APR_FPROT_UREAD */</span>
<a name="l00102"></a><a class="code" href="group__apr__file__permissions.html#ga4faa7fdfa3bcda569dd1e23ae002c5e5">00102</a> <span class="preprocessor">#define APR_UWRITE APR_FPROT_UWRITE </span><span class="comment">/**< @deprecated @see APR_FPROT_UWRITE */</span>
<a name="l00103"></a><a class="code" href="group__apr__file__permissions.html#ga4c08d7e798ab4022e31ed70f06f202b5">00103</a> <span class="preprocessor">#define APR_UEXECUTE APR_FPROT_UEXECUTE </span><span class="comment">/**< @deprecated @see APR_FPROT_UEXECUTE */</span>
<a name="l00104"></a><a class="code" href="group__apr__file__permissions.html#ga4e4e9bb05f2bb156b174461551c9c329">00104</a> <span class="preprocessor">#define APR_GSETID APR_FPROT_GSETID </span><span class="comment">/**< @deprecated @see APR_FPROT_GSETID */</span>
<a name="l00105"></a><a class="code" href="group__apr__file__permissions.html#ga1bd0305f31cb3bb20a8f9db898b96eb1">00105</a> <span class="preprocessor">#define APR_GREAD APR_FPROT_GREAD </span><span class="comment">/**< @deprecated @see APR_FPROT_GREAD */</span>
<a name="l00106"></a><a class="code" href="group__apr__file__permissions.html#ga794c425b459aa46939f6febabbe9daef">00106</a> <span class="preprocessor">#define APR_GWRITE APR_FPROT_GWRITE </span><span class="comment">/**< @deprecated @see APR_FPROT_GWRITE */</span>
<a name="l00107"></a><a class="code" href="group__apr__file__permissions.html#ga79ce615a96a407d6c53325a2f8cdee3d">00107</a> <span class="preprocessor">#define APR_GEXECUTE APR_FPROT_GEXECUTE </span><span class="comment">/**< @deprecated @see APR_FPROT_GEXECUTE */</span>
<a name="l00108"></a><a class="code" href="group__apr__file__permissions.html#ga824d6685d59e3efddb6ee7fdbee69c13">00108</a> <span class="preprocessor">#define APR_WSTICKY APR_FPROT_WSTICKY </span><span class="comment">/**< @deprecated @see APR_FPROT_WSTICKY */</span>
<a name="l00109"></a><a class="code" href="group__apr__file__permissions.html#ga5c987d2b1ace95b4ffa7c5a322721aad">00109</a> <span class="preprocessor">#define APR_WREAD APR_FPROT_WREAD </span><span class="comment">/**< @deprecated @see APR_FPROT_WREAD */</span>
<a name="l00110"></a><a class="code" href="group__apr__file__permissions.html#ga7aac61689e9aaa93176bdb4911f56863">00110</a> <span class="preprocessor">#define APR_WWRITE APR_FPROT_WWRITE </span><span class="comment">/**< @deprecated @see APR_FPROT_WWRITE */</span>
<a name="l00111"></a><a class="code" href="group__apr__file__permissions.html#ga7bf4afea195c62f41aad1d3e94dcdac6">00111</a> <span class="preprocessor">#define APR_WEXECUTE APR_FPROT_WEXECUTE </span><span class="comment">/**< @deprecated @see APR_FPROT_WEXECUTE */</span>
<a name="l00112"></a><a class="code" href="group__apr__file__permissions.html#ga8552adb50d545d5fc7faeabb4f4a388f">00112</a> <span class="preprocessor">#define APR_OS_DEFAULT APR_FPROT_OS_DEFAULT </span><span class="comment">/**< @deprecated @see APR_FPROT_OS_DEFAULT */</span>
<a name="l00113"></a><a class="code" href="group__apr__file__permissions.html#gaa72c8bc4ab1bd5615bee4333d23dc16b">00113</a> <span class="preprocessor">#define APR_FILE_SOURCE_PERMS APR_FPROT_FILE_SOURCE_PERMS </span><span class="comment">/**< @deprecated @see APR_FPROT_FILE_SOURCE_PERMS */</span>
<a name="l00114"></a>00114 <span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment">/** @} */</span>
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="comment"></span>
<a name="l00118"></a>00118 <span class="comment">/**</span>
<a name="l00119"></a>00119 <span class="comment"> * Structure for referencing directories.</span>
<a name="l00120"></a>00120 <span class="comment"> */</span>
<a name="l00121"></a><a class="code" href="group__apr__file__info.html#ga92ed8cf52cba2abb42cf74087aa74da8">00121</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__apr__file__info.html#ga92ed8cf52cba2abb42cf74087aa74da8">apr_dir_t</a> <a class="code" href="group__apr__file__info.html#ga92ed8cf52cba2abb42cf74087aa74da8">apr_dir_t</a>;<span class="comment"></span>
<a name="l00122"></a>00122 <span class="comment">/**</span>
<a name="l00123"></a>00123 <span class="comment"> * Structure for determining file permissions.</span>
<a name="l00124"></a>00124 <span class="comment"> */</span>
<a name="l00125"></a><a class="code" href="group__apr__file__info.html#ga3af19c4c47007169064a70f9351bc7d8">00125</a> <span class="keyword">typedef</span> apr_int32_t <a class="code" href="group__apr__file__info.html#ga3af19c4c47007169064a70f9351bc7d8">apr_fileperms_t</a>;
<a name="l00126"></a>00126 <span class="preprocessor">#if (defined WIN32) || (defined NETWARE)</span>
<a name="l00127"></a>00127 <span class="preprocessor"></span><span class="comment">/**</span>
<a name="l00128"></a>00128 <span class="comment"> * Structure for determining the device the file is on.</span>
<a name="l00129"></a>00129 <span class="comment"> */</span>
<a name="l00130"></a>00130 <span class="keyword">typedef</span> apr_uint32_t <a class="code" href="group__apr__file__info.html#gae2c25c4b679613081599f776efa96c4a">apr_dev_t</a>;
<a name="l00131"></a>00131 <span class="preprocessor">#else</span>
<a name="l00132"></a>00132 <span class="preprocessor"></span><span class="comment">/**</span>
<a name="l00133"></a>00133 <span class="comment"> * Structure for determining the device the file is on.</span>
<a name="l00134"></a>00134 <span class="comment"> */</span>
<a name="l00135"></a><a class="code" href="group__apr__file__info.html#gae2c25c4b679613081599f776efa96c4a">00135</a> <span class="keyword">typedef</span> dev_t apr_dev_t;
<a name="l00136"></a>00136 <span class="preprocessor">#endif</span>
<a name="l00137"></a>00137 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00138"></a>00138 <span class="comment">/**</span>
<a name="l00139"></a>00139 <span class="comment"> * @defgroup apr_file_stat Stat Functions</span>
<a name="l00140"></a>00140 <span class="comment"> * @{</span>
<a name="l00141"></a>00141 <span class="comment"> */</span><span class="comment"></span>
<a name="l00142"></a>00142 <span class="comment">/** file info structure */</span>
<a name="l00143"></a><a class="code" href="group__apr__file__stat.html#ga3d390fdda1d16ae462c11b2d3b18efd1">00143</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structapr__finfo__t.html">apr_finfo_t</a> <a class="code" href="structapr__finfo__t.html">apr_finfo_t</a>;
<a name="l00144"></a>00144
<a name="l00145"></a><a class="code" href="group__apr__file__stat.html#ga9b0c1d02401b845f928f836fdd3c6712">00145</a> <span class="preprocessor">#define APR_FINFO_LINK 0x00000001 </span><span class="comment">/**< Stat the link not the file itself if it is a link */</span>
<a name="l00146"></a><a class="code" href="group__apr__file__stat.html#ga992ce1f4f75d519fd2a9d241c5a12515">00146</a> <span class="preprocessor">#define APR_FINFO_MTIME 0x00000010 </span><span class="comment">/**< Modification Time */</span>
<a name="l00147"></a><a class="code" href="group__apr__file__stat.html#ga98bef78baf71fa63b06352704f128bca">00147</a> <span class="preprocessor">#define APR_FINFO_CTIME 0x00000020 </span><span class="comment">/**< Creation or inode-changed time */</span>
<a name="l00148"></a><a class="code" href="group__apr__file__stat.html#ga17d7656d02a35ffc05afe22032a8da15">00148</a> <span class="preprocessor">#define APR_FINFO_ATIME 0x00000040 </span><span class="comment">/**< Access Time */</span>
<a name="l00149"></a><a class="code" href="group__apr__file__stat.html#gadf72493da450c0b1e3d279e98a973120">00149</a> <span class="preprocessor">#define APR_FINFO_SIZE 0x00000100 </span><span class="comment">/**< Size of the file */</span>
<a name="l00150"></a><a class="code" href="group__apr__file__stat.html#gaf87a09b89935d730cb1ade80d5b6ada0">00150</a> <span class="preprocessor">#define APR_FINFO_CSIZE 0x00000200 </span><span class="comment">/**< Storage size consumed by the file */</span>
<a name="l00151"></a><a class="code" href="group__apr__file__stat.html#ga0890d31145211f62d38dd8e444b5660a">00151</a> <span class="preprocessor">#define APR_FINFO_DEV 0x00001000 </span><span class="comment">/**< Device */</span>
<a name="l00152"></a><a class="code" href="group__apr__file__stat.html#ga4fee7341395912db501b40de81dbba26">00152</a> <span class="preprocessor">#define APR_FINFO_INODE 0x00002000 </span><span class="comment">/**< Inode */</span>
<a name="l00153"></a><a class="code" href="group__apr__file__stat.html#gabb2ba05b8ed45e59b1f06e1b7b4c91c2">00153</a> <span class="preprocessor">#define APR_FINFO_NLINK 0x00004000 </span><span class="comment">/**< Number of links */</span>
<a name="l00154"></a><a class="code" href="group__apr__file__stat.html#gad5d25f25527ee77c08bb20aae141306c">00154</a> <span class="preprocessor">#define APR_FINFO_TYPE 0x00008000 </span><span class="comment">/**< Type */</span>
<a name="l00155"></a><a class="code" href="group__apr__file__stat.html#ga599d92111a5cca379a06980025044e12">00155</a> <span class="preprocessor">#define APR_FINFO_USER 0x00010000 </span><span class="comment">/**< User */</span>
<a name="l00156"></a><a class="code" href="group__apr__file__stat.html#ga8420798139d34a88678498aa848803ff">00156</a> <span class="preprocessor">#define APR_FINFO_GROUP 0x00020000 </span><span class="comment">/**< Group */</span>
<a name="l00157"></a><a class="code" href="group__apr__file__stat.html#gac85e4335fcf91881b11b3e8a4b224aca">00157</a> <span class="preprocessor">#define APR_FINFO_UPROT 0x00100000 </span><span class="comment">/**< User protection bits */</span>
<a name="l00158"></a><a class="code" href="group__apr__file__stat.html#gadfa294303e34528b1fcae1bc009140c1">00158</a> <span class="preprocessor">#define APR_FINFO_GPROT 0x00200000 </span><span class="comment">/**< Group protection bits */</span>
<a name="l00159"></a><a class="code" href="group__apr__file__stat.html#gab970792384fe9a805cf66983350eefdc">00159</a> <span class="preprocessor">#define APR_FINFO_WPROT 0x00400000 </span><span class="comment">/**< World protection bits */</span>
<a name="l00160"></a><a class="code" href="group__apr__file__stat.html#gac46eeba0ae0e771c6ed3cb27fd5492d8">00160</a> <span class="preprocessor">#define APR_FINFO_ICASE 0x01000000 </span><span class="comment">/**< if dev is case insensitive */</span>
<a name="l00161"></a><a class="code" href="group__apr__file__stat.html#ga7fa4caf84808c11a1ec33c5c8d613e4b">00161</a> <span class="preprocessor">#define APR_FINFO_NAME 0x02000000 </span><span class="comment">/**< ->name in proper case */</span>
<a name="l00162"></a>00162
<a name="l00163"></a><a class="code" href="group__apr__file__stat.html#ga341104571b05550aa923cb14898a82ef">00163</a> <span class="preprocessor">#define APR_FINFO_MIN 0x00008170 </span><span class="comment">/**< type, mtime, ctime, atime, size */</span>
<a name="l00164"></a><a class="code" href="group__apr__file__stat.html#ga3ac8c8d0492291417be3d32556464108">00164</a> <span class="preprocessor">#define APR_FINFO_IDENT 0x00003000 </span><span class="comment">/**< dev and inode */</span>
<a name="l00165"></a><a class="code" href="group__apr__file__stat.html#ga27dee9407b38a459c57618098c3920b0">00165</a> <span class="preprocessor">#define APR_FINFO_OWNER 0x00030000 </span><span class="comment">/**< user and group */</span>
<a name="l00166"></a><a class="code" href="group__apr__file__stat.html#gad902be0636860cb3f8ad76a59abbcd7c">00166</a> <span class="preprocessor">#define APR_FINFO_PROT 0x00700000 </span><span class="comment">/**< all protections */</span>
<a name="l00167"></a><a class="code" href="group__apr__file__stat.html#gad3f64010d25d2fe926191804d7c99379">00167</a> <span class="preprocessor">#define APR_FINFO_NORM 0x0073b170 </span><span class="comment">/**< an atomic unix apr_stat() */</span>
<a name="l00168"></a><a class="code" href="group__apr__file__stat.html#gaac6679307cc735f2f0373960db96b931">00168</a> <span class="preprocessor">#define APR_FINFO_DIRENT 0x02000000 </span><span class="comment">/**< an atomic unix apr_dir_read() */</span>
<a name="l00169"></a>00169 <span class="comment"></span>
<a name="l00170"></a>00170 <span class="comment">/**</span>
<a name="l00171"></a>00171 <span class="comment"> * The file information structure. This is analogous to the POSIX</span>
<a name="l00172"></a>00172 <span class="comment"> * stat structure.</span>
<a name="l00173"></a>00173 <span class="comment"> */</span>
<a name="l00174"></a><a class="code" href="structapr__finfo__t.html">00174</a> <span class="keyword">struct </span><a class="code" href="structapr__finfo__t.html">apr_finfo_t</a> {<span class="comment"></span>
<a name="l00175"></a>00175 <span class="comment"> /** Allocates memory and closes lingering handles in the specified pool */</span>
<a name="l00176"></a><a class="code" href="structapr__finfo__t.html#a71496f86b5489c87e58e9c03fe468fb8">00176</a> <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *<a class="code" href="structapr__finfo__t.html#a71496f86b5489c87e58e9c03fe468fb8">pool</a>;<span class="comment"></span>
<a name="l00177"></a>00177 <span class="comment"> /** The bitmask describing valid fields of this apr_finfo_t structure </span>
<a name="l00178"></a>00178 <span class="comment"> * including all available 'wanted' fields and potentially more */</span>
<a name="l00179"></a><a class="code" href="structapr__finfo__t.html#aff0cdf06637edec63c4701e582792019">00179</a> apr_int32_t <a class="code" href="structapr__finfo__t.html#aff0cdf06637edec63c4701e582792019">valid</a>;<span class="comment"></span>
<a name="l00180"></a>00180 <span class="comment"> /** The access permissions of the file. Mimics Unix access rights. */</span>
<a name="l00181"></a><a class="code" href="structapr__finfo__t.html#a7c09d73ad1957e2c0e6c6b77d94e90ab">00181</a> apr_fileperms_t <a class="code" href="structapr__finfo__t.html#a7c09d73ad1957e2c0e6c6b77d94e90ab">protection</a>;<span class="comment"></span>
<a name="l00182"></a>00182 <span class="comment"> /** The type of file. One of APR_REG, APR_DIR, APR_CHR, APR_BLK, APR_PIPE, </span>
<a name="l00183"></a>00183 <span class="comment"> * APR_LNK or APR_SOCK. If the type is undetermined, the value is APR_NOFILE.</span>
<a name="l00184"></a>00184 <span class="comment"> * If the type cannot be determined, the value is APR_UNKFILE.</span>
<a name="l00185"></a>00185 <span class="comment"> */</span>
<a name="l00186"></a><a class="code" href="structapr__finfo__t.html#a274ae0dd60b59182c2e0134bc9a09a20">00186</a> <a class="code" href="group__apr__file__info.html#gae3f0ce3014337a52b39852f8bf81ca7c">apr_filetype_e</a> <a class="code" href="structapr__finfo__t.html#a274ae0dd60b59182c2e0134bc9a09a20">filetype</a>;<span class="comment"></span>
<a name="l00187"></a>00187 <span class="comment"> /** The user id that owns the file */</span>
<a name="l00188"></a><a class="code" href="structapr__finfo__t.html#ab79d14bd50f50662d29ad433166c4bc5">00188</a> <a class="code" href="group__apr__user.html#gad1aa508f584bc230acf4f68ba4fc4de7">apr_uid_t</a> <a class="code" href="structapr__finfo__t.html#ab79d14bd50f50662d29ad433166c4bc5">user</a>;<span class="comment"></span>
<a name="l00189"></a>00189 <span class="comment"> /** The group id that owns the file */</span>
<a name="l00190"></a><a class="code" href="structapr__finfo__t.html#a15c9c056330308de4dafb3826a9b02bc">00190</a> <a class="code" href="group__apr__user.html#ga22e9e224e984f837f3e276833e2f3a55">apr_gid_t</a> <a class="code" href="structapr__finfo__t.html#a15c9c056330308de4dafb3826a9b02bc">group</a>;<span class="comment"></span>
<a name="l00191"></a>00191 <span class="comment"> /** The inode of the file. */</span>
<a name="l00192"></a><a class="code" href="structapr__finfo__t.html#a73aebb666ddc391d53a871802c27eed6">00192</a> apr_ino_t <a class="code" href="structapr__finfo__t.html#a73aebb666ddc391d53a871802c27eed6">inode</a>;<span class="comment"></span>
<a name="l00193"></a>00193 <span class="comment"> /** The id of the device the file is on. */</span>
<a name="l00194"></a><a class="code" href="structapr__finfo__t.html#a38cbfbff641284065481f5907d59c8bf">00194</a> apr_dev_t <a class="code" href="structapr__finfo__t.html#a38cbfbff641284065481f5907d59c8bf">device</a>;<span class="comment"></span>
<a name="l00195"></a>00195 <span class="comment"> /** The number of hard links to the file. */</span>
<a name="l00196"></a><a class="code" href="structapr__finfo__t.html#a98598f28735d75aa0c1994efc825e6d9">00196</a> apr_int32_t <a class="code" href="structapr__finfo__t.html#a98598f28735d75aa0c1994efc825e6d9">nlink</a>;<span class="comment"></span>
<a name="l00197"></a>00197 <span class="comment"> /** The size of the file */</span>
<a name="l00198"></a><a class="code" href="structapr__finfo__t.html#a3e47a673c5b82a25a783a732dee6f946">00198</a> apr_off_t <a class="code" href="structapr__finfo__t.html#a3e47a673c5b82a25a783a732dee6f946">size</a>;<span class="comment"></span>
<a name="l00199"></a>00199 <span class="comment"> /** The storage size consumed by the file */</span>
<a name="l00200"></a><a class="code" href="structapr__finfo__t.html#aeaa4a4def98ad4f162e05c2e2292321d">00200</a> apr_off_t <a class="code" href="structapr__finfo__t.html#aeaa4a4def98ad4f162e05c2e2292321d">csize</a>;<span class="comment"></span>
<a name="l00201"></a>00201 <span class="comment"> /** The time the file was last accessed */</span>
<a name="l00202"></a><a class="code" href="structapr__finfo__t.html#ad78874e5751e9bba30debb0826eb96a7">00202</a> <a class="code" href="group__apr__time.html#gadb4bde16055748190eae190c55aa02bb">apr_time_t</a> <a class="code" href="structapr__finfo__t.html#ad78874e5751e9bba30debb0826eb96a7">atime</a>;<span class="comment"></span>
<a name="l00203"></a>00203 <span class="comment"> /** The time the file was last modified */</span>
<a name="l00204"></a><a class="code" href="structapr__finfo__t.html#afc3bec0f6b3b10160428ba5602a41c60">00204</a> <a class="code" href="group__apr__time.html#gadb4bde16055748190eae190c55aa02bb">apr_time_t</a> <a class="code" href="structapr__finfo__t.html#afc3bec0f6b3b10160428ba5602a41c60">mtime</a>;<span class="comment"></span>
<a name="l00205"></a>00205 <span class="comment"> /** The time the file was created, or the inode was last changed */</span>
<a name="l00206"></a><a class="code" href="structapr__finfo__t.html#aebbdb3dc755d825de3dce901cfba0883">00206</a> <a class="code" href="group__apr__time.html#gadb4bde16055748190eae190c55aa02bb">apr_time_t</a> <a class="code" href="structapr__finfo__t.html#aebbdb3dc755d825de3dce901cfba0883">ctime</a>;<span class="comment"></span>
<a name="l00207"></a>00207 <span class="comment"> /** The pathname of the file (possibly unrooted) */</span>
<a name="l00208"></a><a class="code" href="structapr__finfo__t.html#acfed83ab2943ee7a58a215aa1cfd9e47">00208</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structapr__finfo__t.html#acfed83ab2943ee7a58a215aa1cfd9e47">fname</a>;<span class="comment"></span>
<a name="l00209"></a>00209 <span class="comment"> /** The file's name (no path) in filesystem case */</span>
<a name="l00210"></a><a class="code" href="structapr__finfo__t.html#a2915f9141ea76ae3672ccf9eb0fa77bb">00210</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structapr__finfo__t.html#a2915f9141ea76ae3672ccf9eb0fa77bb">name</a>;<span class="comment"></span>
<a name="l00211"></a>00211 <span class="comment"> /** The file's handle, if accessed (can be submitted to apr_duphandle) */</span>
<a name="l00212"></a><a class="code" href="structapr__finfo__t.html#a7858e3d9c5f6ed062d9ff7f5c79b6336">00212</a> <span class="keyword">struct </span><a class="code" href="group__apr__file__io.html#gaa46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *<a class="code" href="structapr__finfo__t.html#a7858e3d9c5f6ed062d9ff7f5c79b6336">filehand</a>;
<a name="l00213"></a>00213 };
<a name="l00214"></a>00214 <span class="comment"></span>
<a name="l00215"></a>00215 <span class="comment">/**</span>
<a name="l00216"></a>00216 <span class="comment"> * get the specified file's stats. The file is specified by filename, </span>
<a name="l00217"></a>00217 <span class="comment"> * instead of using a pre-opened file.</span>
<a name="l00218"></a>00218 <span class="comment"> * @param finfo Where to store the information about the file, which is</span>
<a name="l00219"></a>00219 <span class="comment"> * never touched if the call fails.</span>
<a name="l00220"></a>00220 <span class="comment"> * @param fname The name of the file to stat.</span>
<a name="l00221"></a>00221 <span class="comment"> * @param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_</span>
<a name="l00222"></a>00222 <span class="comment"> values </span>
<a name="l00223"></a>00223 <span class="comment"> * @param pool the pool to use to allocate the new file. </span>
<a name="l00224"></a>00224 <span class="comment"> *</span>
<a name="l00225"></a>00225 <span class="comment"> * @note If @c APR_INCOMPLETE is returned all the fields in @a finfo may</span>
<a name="l00226"></a>00226 <span class="comment"> * not be filled in, and you need to check the @c finfo->valid bitmask</span>
<a name="l00227"></a>00227 <span class="comment"> * to verify that what you're looking for is there.</span>
<a name="l00228"></a>00228 <span class="comment"> */</span>
<a name="l00229"></a>00229 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__stat.html#gafb0f4a4fa4545c155e20ddd8f2001c1a">apr_stat</a>(<a class="code" href="structapr__finfo__t.html">apr_finfo_t</a> *finfo, const <span class="keywordtype">char</span> *fname,
<a name="l00230"></a>00230 apr_int32_t wanted, <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
<a name="l00231"></a>00231 <span class="comment"></span>
<a name="l00232"></a>00232 <span class="comment">/** @} */</span><span class="comment"></span>
<a name="l00233"></a>00233 <span class="comment">/**</span>
<a name="l00234"></a>00234 <span class="comment"> * @defgroup apr_dir Directory Manipulation Functions</span>
<a name="l00235"></a>00235 <span class="comment"> * @{</span>
<a name="l00236"></a>00236 <span class="comment"> */</span>
<a name="l00237"></a>00237 <span class="comment"></span>
<a name="l00238"></a>00238 <span class="comment">/**</span>
<a name="l00239"></a>00239 <span class="comment"> * Open the specified directory.</span>
<a name="l00240"></a>00240 <span class="comment"> * @param new_dir The opened directory descriptor.</span>
<a name="l00241"></a>00241 <span class="comment"> * @param dirname The full path to the directory (use / on all systems)</span>
<a name="l00242"></a>00242 <span class="comment"> * @param pool The pool to use.</span>
<a name="l00243"></a>00243 <span class="comment"> */</span>
<a name="l00244"></a>00244 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__dir.html#ga796002db3e3c7b7c9d5632efbcd4329c">apr_dir_open</a>(<a class="code" href="group__apr__file__info.html#ga92ed8cf52cba2abb42cf74087aa74da8">apr_dir_t</a> **new_dir,
<a name="l00245"></a>00245 const <span class="keywordtype">char</span> *dirname,
<a name="l00246"></a>00246 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
<a name="l00247"></a>00247 <span class="comment"></span>
<a name="l00248"></a>00248 <span class="comment">/**</span>
<a name="l00249"></a>00249 <span class="comment"> * close the specified directory. </span>
<a name="l00250"></a>00250 <span class="comment"> * @param thedir the directory descriptor to close.</span>
<a name="l00251"></a>00251 <span class="comment"> */</span>
<a name="l00252"></a>00252 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__dir.html#ga57fef00ccea03e9244f6fa21da4d3359">apr_dir_close</a>(<a class="code" href="group__apr__file__info.html#ga92ed8cf52cba2abb42cf74087aa74da8">apr_dir_t</a> *thedir);
<a name="l00253"></a>00253 <span class="comment"></span>
<a name="l00254"></a>00254 <span class="comment">/**</span>
<a name="l00255"></a>00255 <span class="comment"> * Read the next entry from the specified directory. </span>
<a name="l00256"></a>00256 <span class="comment"> * @param finfo the file info structure and filled in by apr_dir_read</span>
<a name="l00257"></a>00257 <span class="comment"> * @param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_</span>
<a name="l00258"></a>00258 <span class="comment"> values </span>
<a name="l00259"></a>00259 <span class="comment"> * @param thedir the directory descriptor returned from apr_dir_open</span>
<a name="l00260"></a>00260 <span class="comment"> * @remark No ordering is guaranteed for the entries read.</span>
<a name="l00261"></a>00261 <span class="comment"> *</span>
<a name="l00262"></a>00262 <span class="comment"> * @note If @c APR_INCOMPLETE is returned all the fields in @a finfo may</span>
<a name="l00263"></a>00263 <span class="comment"> * not be filled in, and you need to check the @c finfo->valid bitmask</span>
<a name="l00264"></a>00264 <span class="comment"> * to verify that what you're looking for is there. When no more</span>
<a name="l00265"></a>00265 <span class="comment"> * entries are available, APR_ENOENT is returned.</span>
<a name="l00266"></a>00266 <span class="comment"> */</span>
<a name="l00267"></a>00267 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__dir.html#ga3e4ee253e0c712160bee10bfb9c8e4a8">apr_dir_read</a>(<a class="code" href="structapr__finfo__t.html">apr_finfo_t</a> *finfo, apr_int32_t wanted,
<a name="l00268"></a>00268 <a class="code" href="group__apr__file__info.html#ga92ed8cf52cba2abb42cf74087aa74da8">apr_dir_t</a> *thedir);
<a name="l00269"></a>00269 <span class="comment"></span>
<a name="l00270"></a>00270 <span class="comment">/**</span>
<a name="l00271"></a>00271 <span class="comment"> * Rewind the directory to the first entry.</span>
<a name="l00272"></a>00272 <span class="comment"> * @param thedir the directory descriptor to rewind.</span>
<a name="l00273"></a>00273 <span class="comment"> */</span>
<a name="l00274"></a>00274 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__dir.html#gab9b9f23e76128144d3fb953cabea6290">apr_dir_rewind</a>(<a class="code" href="group__apr__file__info.html#ga92ed8cf52cba2abb42cf74087aa74da8">apr_dir_t</a> *thedir);<span class="comment"></span>
<a name="l00275"></a>00275 <span class="comment">/** @} */</span>
<a name="l00276"></a>00276 <span class="comment"></span>
<a name="l00277"></a>00277 <span class="comment">/**</span>
<a name="l00278"></a>00278 <span class="comment"> * @defgroup apr_filepath Filepath Manipulation Functions</span>
<a name="l00279"></a>00279 <span class="comment"> * @{</span>
<a name="l00280"></a>00280 <span class="comment"> */</span>
<a name="l00281"></a>00281 <span class="comment"></span>
<a name="l00282"></a>00282 <span class="comment">/** Cause apr_filepath_merge to fail if addpath is above rootpath </span>
<a name="l00283"></a>00283 <span class="comment"> * @bug in APR 0.9 and 1.x, this flag's behavior is undefined</span>
<a name="l00284"></a>00284 <span class="comment"> * if the rootpath is NULL or empty. In APR 2.0 this should be</span>
<a name="l00285"></a>00285 <span class="comment"> * changed to imply NOTABSOLUTE if the rootpath is NULL or empty.</span>
<a name="l00286"></a>00286 <span class="comment"> */</span>
<a name="l00287"></a><a class="code" href="group__apr__filepath.html#gabb57ce7b23caf512d7f64b92a662ab3d">00287</a> <span class="preprocessor">#define APR_FILEPATH_NOTABOVEROOT 0x01</span>
<a name="l00288"></a>00288 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00289"></a>00289 <span class="comment">/** internal: Only meaningful with APR_FILEPATH_NOTABOVEROOT */</span>
<a name="l00290"></a><a class="code" href="group__apr__filepath.html#ga48b6cabfa91e6070c45977ba7035f328">00290</a> <span class="preprocessor">#define APR_FILEPATH_SECUREROOTTEST 0x02</span>
<a name="l00291"></a>00291 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00292"></a>00292 <span class="comment">/** Cause apr_filepath_merge to fail if addpath is above rootpath,</span>
<a name="l00293"></a>00293 <span class="comment"> * even given a rootpath /foo/bar and an addpath ../bar/bash</span>
<a name="l00294"></a>00294 <span class="comment"> */</span>
<a name="l00295"></a><a class="code" href="group__apr__filepath.html#ga6a518889311b81e1d2fc434e7d3acecd">00295</a> <span class="preprocessor">#define APR_FILEPATH_SECUREROOT 0x03</span>
<a name="l00296"></a>00296 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00297"></a>00297 <span class="comment">/** Fail apr_filepath_merge if the merged path is relative */</span>
<a name="l00298"></a><a class="code" href="group__apr__filepath.html#ga487344eb474ea4033b19c386db9aa03a">00298</a> <span class="preprocessor">#define APR_FILEPATH_NOTRELATIVE 0x04</span>
<a name="l00299"></a>00299 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00300"></a>00300 <span class="comment">/** Fail apr_filepath_merge if the merged path is absolute */</span>
<a name="l00301"></a><a class="code" href="group__apr__filepath.html#gaac75b8e9fd5c248b52ac36a1fd6b7f98">00301</a> <span class="preprocessor">#define APR_FILEPATH_NOTABSOLUTE 0x08</span>
<a name="l00302"></a>00302 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00303"></a>00303 <span class="comment">/** Return the file system's native path format (e.g. path delimiters</span>
<a name="l00304"></a>00304 <span class="comment"> * of ':' on MacOS9, '\' on Win32, etc.) */</span>
<a name="l00305"></a><a class="code" href="group__apr__filepath.html#ga2d72ade2cada76d2fa8af3fe4d8fb1de">00305</a> <span class="preprocessor">#define APR_FILEPATH_NATIVE 0x10</span>
<a name="l00306"></a>00306 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00307"></a>00307 <span class="comment">/** Resolve the true case of existing directories and file elements</span>
<a name="l00308"></a>00308 <span class="comment"> * of addpath, (resolving any aliases on Win32) and append a proper </span>
<a name="l00309"></a>00309 <span class="comment"> * trailing slash if a directory</span>
<a name="l00310"></a>00310 <span class="comment"> */</span>
<a name="l00311"></a><a class="code" href="group__apr__filepath.html#gafb7dd411e9ef212a03051806cb60c9d8">00311</a> <span class="preprocessor">#define APR_FILEPATH_TRUENAME 0x20</span>
<a name="l00312"></a>00312 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00313"></a>00313 <span class="comment">/**</span>
<a name="l00314"></a>00314 <span class="comment"> * Extract the rootpath from the given filepath</span>
<a name="l00315"></a>00315 <span class="comment"> * @param rootpath the root file path returned with APR_SUCCESS or APR_EINCOMPLETE</span>
<a name="l00316"></a>00316 <span class="comment"> * @param filepath the pathname to parse for its root component</span>
<a name="l00317"></a>00317 <span class="comment"> * @param flags the desired rules to apply, from</span>
<a name="l00318"></a>00318 <span class="comment"> * <PRE></span>
<a name="l00319"></a>00319 <span class="comment"> * APR_FILEPATH_NATIVE Use native path seperators (e.g. '\' on Win32)</span>
<a name="l00320"></a>00320 <span class="comment"> * APR_FILEPATH_TRUENAME Tests that the root exists, and makes it proper</span>
<a name="l00321"></a>00321 <span class="comment"> * </PRE></span>
<a name="l00322"></a>00322 <span class="comment"> * @param p the pool to allocate the new path string from</span>
<a name="l00323"></a>00323 <span class="comment"> * @remark on return, filepath points to the first non-root character in the</span>
<a name="l00324"></a>00324 <span class="comment"> * given filepath. In the simplest example, given a filepath of "/foo", </span>
<a name="l00325"></a>00325 <span class="comment"> * returns the rootpath of "/" and filepath points at "foo". This is far </span>
<a name="l00326"></a>00326 <span class="comment"> * more complex on other platforms, which will canonicalize the root form</span>
<a name="l00327"></a>00327 <span class="comment"> * to a consistant format, given the APR_FILEPATH_TRUENAME flag, and also</span>
<a name="l00328"></a>00328 <span class="comment"> * test for the validity of that root (e.g., that a drive d:/ or network </span>
<a name="l00329"></a>00329 <span class="comment"> * share //machine/foovol/). </span>
<a name="l00330"></a>00330 <span class="comment"> * The function returns APR_ERELATIVE if filepath isn't rooted (an</span>
<a name="l00331"></a>00331 <span class="comment"> * error), APR_EINCOMPLETE if the root path is ambigious (but potentially</span>
<a name="l00332"></a>00332 <span class="comment"> * legitimate, e.g. "/" on Windows is incomplete because it doesn't specify</span>
<a name="l00333"></a>00333 <span class="comment"> * the drive letter), or APR_EBADPATH if the root is simply invalid.</span>
<a name="l00334"></a>00334 <span class="comment"> * APR_SUCCESS is returned if filepath is an absolute path.</span>
<a name="l00335"></a>00335 <span class="comment"> */</span>
<a name="l00336"></a>00336 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__filepath.html#ga1eacdd5ed069faa137bde014fa50494d">apr_filepath_root</a>(const <span class="keywordtype">char</span> **rootpath,
<a name="l00337"></a>00337 const <span class="keywordtype">char</span> **filepath,
<a name="l00338"></a>00338 apr_int32_t flags,
<a name="l00339"></a>00339 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
<a name="l00340"></a>00340 <span class="comment"></span>
<a name="l00341"></a>00341 <span class="comment">/**</span>
<a name="l00342"></a>00342 <span class="comment"> * Merge additional file path onto the previously processed rootpath</span>
<a name="l00343"></a>00343 <span class="comment"> * @param newpath the merged paths returned</span>
<a name="l00344"></a>00344 <span class="comment"> * @param rootpath the root file path (NULL uses the current working path)</span>
<a name="l00345"></a>00345 <span class="comment"> * @param addpath the path to add to the root path</span>
<a name="l00346"></a>00346 <span class="comment"> * @param flags the desired APR_FILEPATH_ rules to apply when merging</span>
<a name="l00347"></a>00347 <span class="comment"> * @param p the pool to allocate the new path string from</span>
<a name="l00348"></a>00348 <span class="comment"> * @remark if the flag APR_FILEPATH_TRUENAME is given, and the addpath </span>
<a name="l00349"></a>00349 <span class="comment"> * contains wildcard characters ('*', '?') on platforms that don't support </span>
<a name="l00350"></a>00350 <span class="comment"> * such characters within filenames, the paths will be merged, but the </span>
<a name="l00351"></a>00351 <span class="comment"> * result code will be APR_EPATHWILD, and all further segments will not</span>
<a name="l00352"></a>00352 <span class="comment"> * reflect the true filenames including the wildcard and following segments.</span>
<a name="l00353"></a>00353 <span class="comment"> */</span>
<a name="l00354"></a>00354 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__filepath.html#gae89fd67108f10dc5044b6d062dde0138">apr_filepath_merge</a>(<span class="keywordtype">char</span> **newpath,
<a name="l00355"></a>00355 const <span class="keywordtype">char</span> *rootpath,
<a name="l00356"></a>00356 const <span class="keywordtype">char</span> *addpath,
<a name="l00357"></a>00357 apr_int32_t flags,
<a name="l00358"></a>00358 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
<a name="l00359"></a>00359 <span class="comment"></span>
<a name="l00360"></a>00360 <span class="comment">/**</span>
<a name="l00361"></a>00361 <span class="comment"> * Split a search path into separate components</span>
<a name="l00362"></a>00362 <span class="comment"> * @param pathelts the returned components of the search path</span>
<a name="l00363"></a>00363 <span class="comment"> * @param liststr the search path (e.g., <tt>getenv("PATH")</tt>)</span>
<a name="l00364"></a>00364 <span class="comment"> * @param p the pool to allocate the array and path components from</span>
<a name="l00365"></a>00365 <span class="comment"> * @remark empty path componenta do not become part of @a pathelts.</span>
<a name="l00366"></a>00366 <span class="comment"> * @remark the path separator in @a liststr is system specific;</span>
<a name="l00367"></a>00367 <span class="comment"> * e.g., ':' on Unix, ';' on Windows, etc.</span>
<a name="l00368"></a>00368 <span class="comment"> */</span>
<a name="l00369"></a>00369 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__filepath.html#gaf259849de62ac172dde7dcbe73421500">apr_filepath_list_split</a>(<a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> **pathelts,
<a name="l00370"></a>00370 const <span class="keywordtype">char</span> *liststr,
<a name="l00371"></a>00371 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
<a name="l00372"></a>00372 <span class="comment"></span>
<a name="l00373"></a>00373 <span class="comment">/**</span>
<a name="l00374"></a>00374 <span class="comment"> * Merge a list of search path components into a single search path</span>
<a name="l00375"></a>00375 <span class="comment"> * @param liststr the returned search path; may be NULL if @a pathelts is empty</span>
<a name="l00376"></a>00376 <span class="comment"> * @param pathelts the components of the search path</span>
<a name="l00377"></a>00377 <span class="comment"> * @param p the pool to allocate the search path from</span>
<a name="l00378"></a>00378 <span class="comment"> * @remark emtpy strings in the source array are ignored.</span>
<a name="l00379"></a>00379 <span class="comment"> * @remark the path separator in @a liststr is system specific;</span>
<a name="l00380"></a>00380 <span class="comment"> * e.g., ':' on Unix, ';' on Windows, etc.</span>
<a name="l00381"></a>00381 <span class="comment"> */</span>
<a name="l00382"></a>00382 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__filepath.html#ga8316896ab8e3901f9711d9d4cc89b373">apr_filepath_list_merge</a>(<span class="keywordtype">char</span> **liststr,
<a name="l00383"></a>00383 <a class="code" href="structapr__array__header__t.html">apr_array_header_t</a> *pathelts,
<a name="l00384"></a>00384 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
<a name="l00385"></a>00385 <span class="comment"></span>
<a name="l00386"></a>00386 <span class="comment">/**</span>
<a name="l00387"></a>00387 <span class="comment"> * Return the default file path (for relative file names)</span>
<a name="l00388"></a>00388 <span class="comment"> * @param path the default path string returned</span>
<a name="l00389"></a>00389 <span class="comment"> * @param flags optional flag APR_FILEPATH_NATIVE to retrieve the</span>
<a name="l00390"></a>00390 <span class="comment"> * default file path in os-native format.</span>
<a name="l00391"></a>00391 <span class="comment"> * @param p the pool to allocate the default path string from</span>
<a name="l00392"></a>00392 <span class="comment"> */</span>
<a name="l00393"></a>00393 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__filepath.html#gaac7c26321fd60d7304326fe531639507">apr_filepath_get</a>(<span class="keywordtype">char</span> **path, apr_int32_t flags,
<a name="l00394"></a>00394 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
<a name="l00395"></a>00395 <span class="comment"></span>
<a name="l00396"></a>00396 <span class="comment">/**</span>
<a name="l00397"></a>00397 <span class="comment"> * Set the default file path (for relative file names)</span>
<a name="l00398"></a>00398 <span class="comment"> * @param path the default path returned</span>
<a name="l00399"></a>00399 <span class="comment"> * @param p the pool to allocate any working storage</span>
<a name="l00400"></a>00400 <span class="comment"> */</span>
<a name="l00401"></a>00401 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__filepath.html#ga9773589b65b7f0b7d5b59d427fd0eb93">apr_filepath_set</a>(const <span class="keywordtype">char</span> *path, <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
<a name="l00402"></a>00402 <span class="comment"></span>
<a name="l00403"></a>00403 <span class="comment">/** The FilePath character encoding is unknown */</span>
<a name="l00404"></a><a class="code" href="group__apr__filepath.html#ga26cd6345ccc38ae3ad001fd2fa885634">00404</a> <span class="preprocessor">#define APR_FILEPATH_ENCODING_UNKNOWN 0</span>
<a name="l00405"></a>00405 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00406"></a>00406 <span class="comment">/** The FilePath character encoding is locale-dependent */</span>
<a name="l00407"></a><a class="code" href="group__apr__filepath.html#gaecb3193c8e36fbf58564f94b8c38b6d9">00407</a> <span class="preprocessor">#define APR_FILEPATH_ENCODING_LOCALE 1</span>
<a name="l00408"></a>00408 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00409"></a>00409 <span class="comment">/** The FilePath character encoding is UTF-8 */</span>
<a name="l00410"></a><a class="code" href="group__apr__filepath.html#ga1c99d1644a8b49dc0be166bdc352819a">00410</a> <span class="preprocessor">#define APR_FILEPATH_ENCODING_UTF8 2</span>
<a name="l00411"></a>00411 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00412"></a>00412 <span class="comment">/**</span>
<a name="l00413"></a>00413 <span class="comment"> * Determine the encoding used internally by the FilePath functions</span>
<a name="l00414"></a>00414 <span class="comment"> * @param style points to a variable which receives the encoding style flag</span>
<a name="l00415"></a>00415 <span class="comment"> * @param p the pool to allocate any working storage</span>
<a name="l00416"></a>00416 <span class="comment"> * @remark Use @c apr_os_locale_encoding and/or @c apr_os_default_encoding</span>
<a name="l00417"></a>00417 <span class="comment"> * to get the name of the path encoding if it's not UTF-8.</span>
<a name="l00418"></a>00418 <span class="comment"> */</span>
<a name="l00419"></a>00419 <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__filepath.html#gad4d3a5888a54a52b3552911e448a3eb3">apr_filepath_encoding</a>(<span class="keywordtype">int</span> *style, <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);<span class="comment"></span>
<a name="l00420"></a>00420 <span class="comment">/** @} */</span>
<a name="l00421"></a>00421 <span class="comment"></span>
<a name="l00422"></a>00422 <span class="comment">/** @} */</span>
<a name="l00423"></a>00423
<a name="l00424"></a>00424 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00425"></a>00425 <span class="preprocessor"></span>}
<a name="l00426"></a>00426 <span class="preprocessor">#endif</span>
<a name="l00427"></a>00427 <span class="preprocessor"></span>
<a name="l00428"></a>00428 <span class="preprocessor">#endif </span><span class="comment">/* ! APR_FILE_INFO_H */</span>
</pre></div></div>
<!--- 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>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Feb 14 10:09:01 2012 for Apache Portable Runtime by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
e0236b39c613e86bcee76bad717809a5
>
files
>
93
