apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bo...@apache.org
Subject svn commit: r784636 [10/47] - in /apr/site/trunk/docs/docs: apr-util/trunk/ apr/trunk/
Date Mon, 15 Jun 2009 00:01:47 GMT
Modified: apr/site/trunk/docs/docs/apr/trunk/apr__file__io_8h-source.html
URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__file__io_8h-source.html?rev=784636&r1=784635&r2=784636&view=diff
==============================================================================
--- apr/site/trunk/docs/docs/apr/trunk/apr__file__io_8h-source.html (original)
+++ apr/site/trunk/docs/docs/apr/trunk/apr__file__io_8h-source.html Mon Jun 15 00:01:38 2009
@@ -1,16 +1,17 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
 <title>Apache Portable Runtime: apr_file_io.h Source File</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
 <link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
 </head><body>
-<!-- Generated by Doxygen 1.5.7.1 -->
+<!-- Generated by Doxygen 1.5.8 -->
 <div class="navigation" id="top">
   <div class="tabs">
     <ul>
       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
       <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
       <li class="current"><a href="files.html"><span>Files</span></a></li>
       <li><a href="examples.html"><span>Examples</span></a></li>
@@ -589,373 +590,385 @@
 <a name="l00565"></a>00565 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g68aba780b7fc53e47404bfd8def949bc">apr_file_flush</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile);
 <a name="l00566"></a>00566 <span class="comment"></span>
 <a name="l00567"></a>00567 <span class="comment">/**</span>
-<a name="l00568"></a>00568 <span class="comment"> * Duplicate the specified file descriptor.</span>
-<a name="l00569"></a>00569 <span class="comment"> * @param new_file The structure to duplicate into. </span>
-<a name="l00570"></a>00570 <span class="comment"> * @param old_file The file to duplicate.</span>
-<a name="l00571"></a>00571 <span class="comment"> * @param p The pool to use for the new file.</span>
-<a name="l00572"></a>00572 <span class="comment"> * @remark *new_file must point to a valid apr_file_t, or point to NULL.</span>
-<a name="l00573"></a>00573 <span class="comment"> */</span>         
-<a name="l00574"></a>00574 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g6e849af1b0fd31669c58a803fcb13837">apr_file_dup</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> **new_file,
-<a name="l00575"></a>00575                                        <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *old_file,
-<a name="l00576"></a>00576                                        <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
-<a name="l00577"></a>00577 <span class="comment"></span>
-<a name="l00578"></a>00578 <span class="comment">/**</span>
-<a name="l00579"></a>00579 <span class="comment"> * Duplicate the specified file descriptor and close the original</span>
-<a name="l00580"></a>00580 <span class="comment"> * @param new_file The old file that is to be closed and reused</span>
-<a name="l00581"></a>00581 <span class="comment"> * @param old_file The file to duplicate</span>
-<a name="l00582"></a>00582 <span class="comment"> * @param p        The pool to use for the new file</span>
-<a name="l00583"></a>00583 <span class="comment"> *</span>
-<a name="l00584"></a>00584 <span class="comment"> * @remark new_file MUST point at a valid apr_file_t. It cannot be NULL.</span>
-<a name="l00585"></a>00585 <span class="comment"> */</span>
-<a name="l00586"></a>00586 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g602926aad867088297e8f59490ff939c">apr_file_dup2</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *new_file,
-<a name="l00587"></a>00587                                         <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *old_file,
-<a name="l00588"></a>00588                                         <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
+<a name="l00568"></a>00568 <span class="comment"> * Transfer all file modified data and metadata to disk.</span>
+<a name="l00569"></a>00569 <span class="comment"> * @param thefile The file descriptor to sync</span>
+<a name="l00570"></a>00570 <span class="comment"> */</span>
+<a name="l00571"></a>00571 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g4385e141c4bbb96294acd7d342f138da">apr_file_sync</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile);
+<a name="l00572"></a>00572 <span class="comment"></span>
+<a name="l00573"></a>00573 <span class="comment">/**</span>
+<a name="l00574"></a>00574 <span class="comment"> * Transfer all file modified data to disk.</span>
+<a name="l00575"></a>00575 <span class="comment"> * @param thefile The file descriptor to sync</span>
+<a name="l00576"></a>00576 <span class="comment"> */</span>
+<a name="l00577"></a>00577 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#ga4b4e5027c1d8dbe4e5cb47b8eebc03b">apr_file_datasync</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile);
+<a name="l00578"></a>00578 <span class="comment"></span>
+<a name="l00579"></a>00579 <span class="comment">/**</span>
+<a name="l00580"></a>00580 <span class="comment"> * Duplicate the specified file descriptor.</span>
+<a name="l00581"></a>00581 <span class="comment"> * @param new_file The structure to duplicate into. </span>
+<a name="l00582"></a>00582 <span class="comment"> * @param old_file The file to duplicate.</span>
+<a name="l00583"></a>00583 <span class="comment"> * @param p The pool to use for the new file.</span>
+<a name="l00584"></a>00584 <span class="comment"> * @remark *new_file must point to a valid apr_file_t, or point to NULL.</span>
+<a name="l00585"></a>00585 <span class="comment"> */</span>         
+<a name="l00586"></a>00586 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g6e849af1b0fd31669c58a803fcb13837">apr_file_dup</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> **new_file,
+<a name="l00587"></a>00587                                        <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *old_file,
+<a name="l00588"></a>00588                                        <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
 <a name="l00589"></a>00589 <span class="comment"></span>
 <a name="l00590"></a>00590 <span class="comment">/**</span>
-<a name="l00591"></a>00591 <span class="comment"> * Move the specified file descriptor to a new pool</span>
-<a name="l00592"></a>00592 <span class="comment"> * @param new_file Pointer in which to return the new apr_file_t</span>
-<a name="l00593"></a>00593 <span class="comment"> * @param old_file The file to move</span>
-<a name="l00594"></a>00594 <span class="comment"> * @param p        The pool to which the descriptor is to be moved</span>
-<a name="l00595"></a>00595 <span class="comment"> * @remark Unlike apr_file_dup2(), this function doesn't do an</span>
-<a name="l00596"></a>00596 <span class="comment"> *         OS dup() operation on the underlying descriptor; it just</span>
-<a name="l00597"></a>00597 <span class="comment"> *         moves the descriptor's apr_file_t wrapper to a new pool.</span>
-<a name="l00598"></a>00598 <span class="comment"> * @remark The new pool need not be an ancestor of old_file's pool.</span>
-<a name="l00599"></a>00599 <span class="comment"> * @remark After calling this function, old_file may not be used</span>
-<a name="l00600"></a>00600 <span class="comment"> */</span>
-<a name="l00601"></a>00601 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gdaf046ce39aa118dab921a407446355b">apr_file_setaside</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> **new_file,
-<a name="l00602"></a>00602                                             <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *old_file,
-<a name="l00603"></a>00603                                             <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
-<a name="l00604"></a>00604 <span class="comment"></span>
-<a name="l00605"></a>00605 <span class="comment">/**</span>
-<a name="l00606"></a>00606 <span class="comment"> * Give the specified apr file handle a new buffer </span>
-<a name="l00607"></a>00607 <span class="comment"> * @param thefile  The file handle that is to be modified</span>
-<a name="l00608"></a>00608 <span class="comment"> * @param buffer   The buffer</span>
-<a name="l00609"></a>00609 <span class="comment"> * @param bufsize  The size of the buffer</span>
-<a name="l00610"></a>00610 <span class="comment"> * @remark It is possible to add a buffer to previously unbuffered</span>
-<a name="l00611"></a>00611 <span class="comment"> *         file handles, the APR_BUFFERED flag will be added to</span>
-<a name="l00612"></a>00612 <span class="comment"> *         the file handle's flags. Likewise, with buffer=NULL and</span>
-<a name="l00613"></a>00613 <span class="comment"> *         bufsize=0 arguments it is possible to make a previously</span>
-<a name="l00614"></a>00614 <span class="comment"> *         buffered file handle unbuffered.</span>
-<a name="l00615"></a>00615 <span class="comment"> */</span>
-<a name="l00616"></a>00616 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gfe4be8c3b62c42535b84d4237bf6e421">apr_file_buffer_set</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile,
-<a name="l00617"></a>00617                                               <span class="keywordtype">char</span> * buffer,
-<a name="l00618"></a>00618                                               apr_size_t bufsize);
-<a name="l00619"></a>00619 <span class="comment"></span>
-<a name="l00620"></a>00620 <span class="comment">/**</span>
-<a name="l00621"></a>00621 <span class="comment"> * Get the size of any buffer for the specified apr file handle </span>
-<a name="l00622"></a>00622 <span class="comment"> * @param thefile  The file handle </span>
-<a name="l00623"></a>00623 <span class="comment"> */</span>
-<a name="l00624"></a>00624 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(apr_size_t) <a class="code" href="group__apr__file__io.html#g42bbb9227095686ea15eb79f99d248a2">apr_file_buffer_size_get</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile);
-<a name="l00625"></a>00625 <span class="comment"></span>
-<a name="l00626"></a>00626 <span class="comment">/**</span>
-<a name="l00627"></a>00627 <span class="comment"> * Move the read/write file offset to a specified byte within a file.</span>
-<a name="l00628"></a>00628 <span class="comment"> * @param thefile The file descriptor</span>
-<a name="l00629"></a>00629 <span class="comment"> * @param where How to move the pointer, one of:</span>
-<a name="l00630"></a>00630 <span class="comment"> * &lt;PRE&gt;</span>
-<a name="l00631"></a>00631 <span class="comment"> *            APR_SET  --  set the offset to offset</span>
-<a name="l00632"></a>00632 <span class="comment"> *            APR_CUR  --  add the offset to the current position </span>
-<a name="l00633"></a>00633 <span class="comment"> *            APR_END  --  add the offset to the current file size </span>
-<a name="l00634"></a>00634 <span class="comment"> * &lt;/PRE&gt;</span>
-<a name="l00635"></a>00635 <span class="comment"> * @param offset The offset to move the pointer to.</span>
-<a name="l00636"></a>00636 <span class="comment"> * @remark The third argument is modified to be the offset the pointer</span>
-<a name="l00637"></a>00637 <span class="comment">          was actually moved to.</span>
-<a name="l00638"></a>00638 <span class="comment"> */</span>
-<a name="l00639"></a>00639 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g9db84bec24db97a53890df1a6aff63a1">apr_file_seek</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile, 
-<a name="l00640"></a>00640                                    apr_seek_where_t where,
-<a name="l00641"></a>00641                                    apr_off_t *offset);
-<a name="l00642"></a>00642 <span class="comment"></span>
-<a name="l00643"></a>00643 <span class="comment">/**</span>
-<a name="l00644"></a>00644 <span class="comment"> * Create an anonymous pipe.</span>
-<a name="l00645"></a>00645 <span class="comment"> * @param in The newly created pipe's file for reading.</span>
-<a name="l00646"></a>00646 <span class="comment"> * @param out The newly created pipe's file for writing.</span>
-<a name="l00647"></a>00647 <span class="comment"> * @param pool The pool to operate on.</span>
-<a name="l00648"></a>00648 <span class="comment"> * @remark By default, the returned file descriptors will be inherited</span>
-<a name="l00649"></a>00649 <span class="comment"> * by child processes created using apr_proc_create().  This can be</span>
-<a name="l00650"></a>00650 <span class="comment"> * changed using apr_file_inherit_unset().</span>
-<a name="l00651"></a>00651 <span class="comment"> * @bug  Some platforms cannot toggle between blocking and nonblocking,</span>
-<a name="l00652"></a>00652 <span class="comment"> * and when passing a pipe as a standard handle to an application which</span>
-<a name="l00653"></a>00653 <span class="comment"> * does not expect it, a non-blocking stream will fluxor the client app.</span>
-<a name="l00654"></a>00654 <span class="comment"> * @deprecated @see apr_file_pipe_create_ex</span>
-<a name="l00655"></a>00655 <span class="comment"> */</span>
-<a name="l00656"></a>00656 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gae3b81342d239c58c351cf11190740ed">apr_file_pipe_create</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> **in, 
-<a name="l00657"></a>00657                                                <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> **out,
-<a name="l00658"></a>00658                                                <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
-<a name="l00659"></a>00659 <span class="comment"></span>
-<a name="l00660"></a>00660 <span class="comment">/**</span>
-<a name="l00661"></a>00661 <span class="comment"> * Create an anonymous pipe which portably supports async timeout options.</span>
-<a name="l00662"></a>00662 <span class="comment"> * @param in The newly created pipe's file for reading.</span>
-<a name="l00663"></a>00663 <span class="comment"> * @param out The newly created pipe's file for writing.</span>
-<a name="l00664"></a>00664 <span class="comment"> * @param blocking one of these values defined in apr_thread_proc.h;</span>
-<a name="l00665"></a>00665 <span class="comment"> * &lt;pre&gt;</span>
-<a name="l00666"></a>00666 <span class="comment"> *       APR_FULL_BLOCK</span>
-<a name="l00667"></a>00667 <span class="comment"> *       APR_READ_BLOCK</span>
-<a name="l00668"></a>00668 <span class="comment"> *       APR_WRITE_BLOCK</span>
-<a name="l00669"></a>00669 <span class="comment"> *       APR_FULL_NONBLOCK</span>
-<a name="l00670"></a>00670 <span class="comment"> * &lt;/pre&gt;</span>
-<a name="l00671"></a>00671 <span class="comment"> * @remark By default, the returned file descriptors will be inherited</span>
-<a name="l00672"></a>00672 <span class="comment"> * by child processes created using apr_proc_create().  This can be</span>
-<a name="l00673"></a>00673 <span class="comment"> * changed using apr_file_inherit_unset().</span>
-<a name="l00674"></a>00674 <span class="comment"> * @remark Some platforms cannot toggle between blocking and nonblocking,</span>
-<a name="l00675"></a>00675 <span class="comment"> * and when passing a pipe as a standard handle to an application which</span>
-<a name="l00676"></a>00676 <span class="comment"> * does not expect it, a non-blocking stream will fluxor the client app.</span>
-<a name="l00677"></a>00677 <span class="comment"> * Use this function rather than apr_file_pipe_create to create pipes </span>
-<a name="l00678"></a>00678 <span class="comment"> * where one or both ends require non-blocking semantics.</span>
-<a name="l00679"></a>00679 <span class="comment"> */</span>
-<a name="l00680"></a>00680 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gc365ab74c583eb1df5cd05660a81b5c8">apr_file_pipe_create_ex</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> **in, 
-<a name="l00681"></a>00681                                                   <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> **out, 
-<a name="l00682"></a>00682                                                   apr_int32_t blocking, 
-<a name="l00683"></a>00683                                                   <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
-<a name="l00684"></a>00684 <span class="comment"></span>
-<a name="l00685"></a>00685 <span class="comment">/**</span>
-<a name="l00686"></a>00686 <span class="comment"> * Create a named pipe.</span>
-<a name="l00687"></a>00687 <span class="comment"> * @param filename The filename of the named pipe</span>
-<a name="l00688"></a>00688 <span class="comment"> * @param perm The permissions for the newly created pipe.</span>
-<a name="l00689"></a>00689 <span class="comment"> * @param pool The pool to operate on.</span>
-<a name="l00690"></a>00690 <span class="comment"> */</span>
-<a name="l00691"></a>00691 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g60cec3e6717bab0f11577bd7c38b4c59">apr_file_namedpipe_create</a>(const <span class="keywordtype">char</span> *filename, 
-<a name="l00692"></a>00692                                                     <a class="code" href="group__apr__file__info.html#g3af19c4c47007169064a70f9351bc7d8">apr_fileperms_t</a> perm, 
-<a name="l00693"></a>00693                                                     <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
-<a name="l00694"></a>00694 <span class="comment"></span>
-<a name="l00695"></a>00695 <span class="comment">/**</span>
-<a name="l00696"></a>00696 <span class="comment"> * Get the timeout value for a pipe or manipulate the blocking state.</span>
-<a name="l00697"></a>00697 <span class="comment"> * @param thepipe The pipe we are getting a timeout for.</span>
-<a name="l00698"></a>00698 <span class="comment"> * @param timeout The current timeout value in microseconds. </span>
-<a name="l00699"></a>00699 <span class="comment"> */</span>
-<a name="l00700"></a>00700 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g90e481207a38df04818a0c55883ee953">apr_file_pipe_timeout_get</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thepipe, 
-<a name="l00701"></a>00701                                                <a class="code" href="group__apr__time.html#gae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a> *timeout);
-<a name="l00702"></a>00702 <span class="comment"></span>
-<a name="l00703"></a>00703 <span class="comment">/**</span>
-<a name="l00704"></a>00704 <span class="comment"> * Set the timeout value for a pipe or manipulate the blocking state.</span>
-<a name="l00705"></a>00705 <span class="comment"> * @param thepipe The pipe we are setting a timeout on.</span>
-<a name="l00706"></a>00706 <span class="comment"> * @param timeout The timeout value in microseconds.  Values &lt; 0 mean wait </span>
-<a name="l00707"></a>00707 <span class="comment"> *        forever, 0 means do not wait at all.</span>
-<a name="l00708"></a>00708 <span class="comment"> */</span>
-<a name="l00709"></a>00709 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gf88d2fca768e3fa9f28ea010e1bf602a">apr_file_pipe_timeout_set</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thepipe, 
-<a name="l00710"></a>00710                                                   <a class="code" href="group__apr__time.html#gae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a> timeout);
-<a name="l00711"></a>00711 <span class="comment"></span>
-<a name="l00712"></a>00712 <span class="comment">/** file (un)locking functions. */</span>
-<a name="l00713"></a>00713 <span class="comment"></span>
-<a name="l00714"></a>00714 <span class="comment">/**</span>
-<a name="l00715"></a>00715 <span class="comment"> * Establish a lock on the specified, open file. The lock may be advisory</span>
-<a name="l00716"></a>00716 <span class="comment"> * or mandatory, at the discretion of the platform. The lock applies to</span>
-<a name="l00717"></a>00717 <span class="comment"> * the file as a whole, rather than a specific range. Locks are established</span>
-<a name="l00718"></a>00718 <span class="comment"> * on a per-thread/process basis; a second lock by the same thread will not</span>
-<a name="l00719"></a>00719 <span class="comment"> * block.</span>
-<a name="l00720"></a>00720 <span class="comment"> * @param thefile The file to lock.</span>
-<a name="l00721"></a>00721 <span class="comment"> * @param type The type of lock to establish on the file.</span>
-<a name="l00722"></a>00722 <span class="comment"> */</span>
-<a name="l00723"></a>00723 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g2d337e66c1fa0cd433164079bf542484">apr_file_lock</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile, <span class="keywordtype">int</span> type);
-<a name="l00724"></a>00724 <span class="comment"></span>
-<a name="l00725"></a>00725 <span class="comment">/**</span>
-<a name="l00726"></a>00726 <span class="comment"> * Remove any outstanding locks on the file.</span>
-<a name="l00727"></a>00727 <span class="comment"> * @param thefile The file to unlock.</span>
-<a name="l00728"></a>00728 <span class="comment"> */</span>
-<a name="l00729"></a>00729 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g3a255996fb439b6d66ed7cd65319525b">apr_file_unlock</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile);
-<a name="l00730"></a>00730 <span class="comment"></span>
-<a name="l00731"></a>00731 <span class="comment">/**accessor and general file_io functions. */</span>
-<a name="l00732"></a>00732 <span class="comment"></span>
-<a name="l00733"></a>00733 <span class="comment">/**</span>
-<a name="l00734"></a>00734 <span class="comment"> * return the file name of the current file.</span>
-<a name="l00735"></a>00735 <span class="comment"> * @param new_path The path of the file.  </span>
-<a name="l00736"></a>00736 <span class="comment"> * @param thefile The currently open file.</span>
-<a name="l00737"></a>00737 <span class="comment"> */</span>                     
-<a name="l00738"></a>00738 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g5c750a88fe1e032e1d85d3db40d9519f">apr_file_name_get</a>(const <span class="keywordtype">char</span> **new_path, 
-<a name="l00739"></a>00739                                             <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile);
-<a name="l00740"></a>00740     <span class="comment"></span>
-<a name="l00741"></a>00741 <span class="comment">/**</span>
-<a name="l00742"></a>00742 <span class="comment"> * Return the data associated with the current file.</span>
-<a name="l00743"></a>00743 <span class="comment"> * @param data The user data associated with the file.  </span>
-<a name="l00744"></a>00744 <span class="comment"> * @param key The key to use for retreiving data associated with this file.</span>
-<a name="l00745"></a>00745 <span class="comment"> * @param file The currently open file.</span>
-<a name="l00746"></a>00746 <span class="comment"> */</span>                     
-<a name="l00747"></a>00747 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gfa13b7024748a7e45344d6998ddbd281">apr_file_data_get</a>(<span class="keywordtype">void</span> **data, const <span class="keywordtype">char</span> *key, 
-<a name="l00748"></a>00748                                             <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *file);
-<a name="l00749"></a>00749 <span class="comment"></span>
-<a name="l00750"></a>00750 <span class="comment">/**</span>
-<a name="l00751"></a>00751 <span class="comment"> * Set the data associated with the current file.</span>
-<a name="l00752"></a>00752 <span class="comment"> * @param file The currently open file.</span>
-<a name="l00753"></a>00753 <span class="comment"> * @param data The user data to associate with the file.  </span>
-<a name="l00754"></a>00754 <span class="comment"> * @param key The key to use for assocaiteing data with the file.</span>
-<a name="l00755"></a>00755 <span class="comment"> * @param cleanup The cleanup routine to use when the file is destroyed.</span>
-<a name="l00756"></a>00756 <span class="comment"> */</span>                     
-<a name="l00757"></a>00757 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g58c857162593d8b3aa999df5b7af0805">apr_file_data_set</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *file, <span class="keywordtype">void</span> *data,
-<a name="l00758"></a>00758                                             const <span class="keywordtype">char</span> *key,
-<a name="l00759"></a>00759                                             <a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*cleanup)(<span class="keywordtype">void</span> *));
-<a name="l00760"></a>00760 <span class="comment"></span>
-<a name="l00761"></a>00761 <span class="comment">/**</span>
-<a name="l00762"></a>00762 <span class="comment"> * Write a string to a file using a printf format.</span>
-<a name="l00763"></a>00763 <span class="comment"> * @param fptr The file to write to.</span>
-<a name="l00764"></a>00764 <span class="comment"> * @param format The format string</span>
-<a name="l00765"></a>00765 <span class="comment"> * @param ... The values to substitute in the format string</span>
-<a name="l00766"></a>00766 <span class="comment"> * @return The number of bytes written</span>
-<a name="l00767"></a>00767 <span class="comment"> */</span> 
-<a name="l00768"></a>00768 <a class="code" href="group__apr__platform.html#g3ad5e45fabbda0ec5f106c334f1a0ae5">APR_DECLARE_NONSTD</a>(<span class="keywordtype">int</span>) <a class="code" href="group__apr__file__io.html#g29fca4b0201c236856fea5578f410c0e">apr_file_printf</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *fptr, 
-<a name="l00769"></a>00769                                         const <span class="keywordtype">char</span> *format, ...)
-<a name="l00770"></a>00770         __attribute__((format(printf,2,3)));
-<a name="l00771"></a>00771 <span class="comment"></span>
-<a name="l00772"></a>00772 <span class="comment">/**</span>
-<a name="l00773"></a>00773 <span class="comment"> * set the specified file's permission bits.</span>
-<a name="l00774"></a>00774 <span class="comment"> * @param fname The file (name) to apply the permissions to.</span>
-<a name="l00775"></a>00775 <span class="comment"> * @param perms The permission bits to apply to the file.</span>
-<a name="l00776"></a>00776 <span class="comment"> *</span>
-<a name="l00777"></a>00777 <span class="comment"> * @warning Some platforms may not be able to apply all of the</span>
-<a name="l00778"></a>00778 <span class="comment"> * available permission bits; APR_INCOMPLETE will be returned if some</span>
-<a name="l00779"></a>00779 <span class="comment"> * permissions are specified which could not be set.</span>
-<a name="l00780"></a>00780 <span class="comment"> *</span>
-<a name="l00781"></a>00781 <span class="comment"> * @warning Platforms which do not implement this feature will return</span>
-<a name="l00782"></a>00782 <span class="comment"> * APR_ENOTIMPL.</span>
-<a name="l00783"></a>00783 <span class="comment"> */</span>
-<a name="l00784"></a>00784 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gc5fed6d75597476718c40fc603823b1e">apr_file_perms_set</a>(const <span class="keywordtype">char</span> *fname,
-<a name="l00785"></a>00785                                              <a class="code" href="group__apr__file__info.html#g3af19c4c47007169064a70f9351bc7d8">apr_fileperms_t</a> perms);
-<a name="l00786"></a>00786 <span class="comment"></span>
-<a name="l00787"></a>00787 <span class="comment">/**</span>
-<a name="l00788"></a>00788 <span class="comment"> * Set attributes of the specified file.</span>
-<a name="l00789"></a>00789 <span class="comment"> * @param fname The full path to the file (using / on all systems)</span>
-<a name="l00790"></a>00790 <span class="comment"> * @param attributes Or'd combination of</span>
-<a name="l00791"></a>00791 <span class="comment"> * &lt;PRE&gt;</span>
-<a name="l00792"></a>00792 <span class="comment"> *            APR_FILE_ATTR_READONLY   - make the file readonly</span>
-<a name="l00793"></a>00793 <span class="comment"> *            APR_FILE_ATTR_EXECUTABLE - make the file executable</span>
-<a name="l00794"></a>00794 <span class="comment"> *            APR_FILE_ATTR_HIDDEN     - make the file hidden</span>
-<a name="l00795"></a>00795 <span class="comment"> * &lt;/PRE&gt;</span>
-<a name="l00796"></a>00796 <span class="comment"> * @param attr_mask Mask of valid bits in attributes.</span>
-<a name="l00797"></a>00797 <span class="comment"> * @param pool the pool to use.</span>
-<a name="l00798"></a>00798 <span class="comment"> * @remark This function should be used in preference to explict manipulation</span>
-<a name="l00799"></a>00799 <span class="comment"> *      of the file permissions, because the operations to provide these</span>
-<a name="l00800"></a>00800 <span class="comment"> *      attributes are platform specific and may involve more than simply</span>
-<a name="l00801"></a>00801 <span class="comment"> *      setting permission bits.</span>
-<a name="l00802"></a>00802 <span class="comment"> * @warning Platforms which do not implement this feature will return</span>
-<a name="l00803"></a>00803 <span class="comment"> *      APR_ENOTIMPL.</span>
-<a name="l00804"></a>00804 <span class="comment"> */</span>
-<a name="l00805"></a>00805 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g96ceec3492ad0c75d2b58c167087ee6a">apr_file_attrs_set</a>(const <span class="keywordtype">char</span> *fname,
-<a name="l00806"></a>00806                                              apr_fileattrs_t attributes,
-<a name="l00807"></a>00807                                              apr_fileattrs_t attr_mask,
-<a name="l00808"></a>00808                                              <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
-<a name="l00809"></a>00809 <span class="comment"></span>
-<a name="l00810"></a>00810 <span class="comment">/**</span>
-<a name="l00811"></a>00811 <span class="comment"> * Set the mtime of the specified file.</span>
-<a name="l00812"></a>00812 <span class="comment"> * @param fname The full path to the file (using / on all systems)</span>
-<a name="l00813"></a>00813 <span class="comment"> * @param mtime The mtime to apply to the file.</span>
-<a name="l00814"></a>00814 <span class="comment"> * @param pool The pool to use.</span>
-<a name="l00815"></a>00815 <span class="comment"> * @warning Platforms which do not implement this feature will return</span>
-<a name="l00816"></a>00816 <span class="comment"> *      APR_ENOTIMPL.</span>
-<a name="l00817"></a>00817 <span class="comment"> */</span>
-<a name="l00818"></a>00818 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g79f58458a00a4072622005c09ed8f96f">apr_file_mtime_set</a>(const <span class="keywordtype">char</span> *fname,
-<a name="l00819"></a>00819                                              <a class="code" href="group__apr__time.html#gdb4bde16055748190eae190c55aa02bb">apr_time_t</a> mtime,
+<a name="l00591"></a>00591 <span class="comment"> * Duplicate the specified file descriptor and close the original</span>
+<a name="l00592"></a>00592 <span class="comment"> * @param new_file The old file that is to be closed and reused</span>
+<a name="l00593"></a>00593 <span class="comment"> * @param old_file The file to duplicate</span>
+<a name="l00594"></a>00594 <span class="comment"> * @param p        The pool to use for the new file</span>
+<a name="l00595"></a>00595 <span class="comment"> *</span>
+<a name="l00596"></a>00596 <span class="comment"> * @remark new_file MUST point at a valid apr_file_t. It cannot be NULL.</span>
+<a name="l00597"></a>00597 <span class="comment"> */</span>
+<a name="l00598"></a>00598 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g602926aad867088297e8f59490ff939c">apr_file_dup2</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *new_file,
+<a name="l00599"></a>00599                                         <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *old_file,
+<a name="l00600"></a>00600                                         <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
+<a name="l00601"></a>00601 <span class="comment"></span>
+<a name="l00602"></a>00602 <span class="comment">/**</span>
+<a name="l00603"></a>00603 <span class="comment"> * Move the specified file descriptor to a new pool</span>
+<a name="l00604"></a>00604 <span class="comment"> * @param new_file Pointer in which to return the new apr_file_t</span>
+<a name="l00605"></a>00605 <span class="comment"> * @param old_file The file to move</span>
+<a name="l00606"></a>00606 <span class="comment"> * @param p        The pool to which the descriptor is to be moved</span>
+<a name="l00607"></a>00607 <span class="comment"> * @remark Unlike apr_file_dup2(), this function doesn't do an</span>
+<a name="l00608"></a>00608 <span class="comment"> *         OS dup() operation on the underlying descriptor; it just</span>
+<a name="l00609"></a>00609 <span class="comment"> *         moves the descriptor's apr_file_t wrapper to a new pool.</span>
+<a name="l00610"></a>00610 <span class="comment"> * @remark The new pool need not be an ancestor of old_file's pool.</span>
+<a name="l00611"></a>00611 <span class="comment"> * @remark After calling this function, old_file may not be used</span>
+<a name="l00612"></a>00612 <span class="comment"> */</span>
+<a name="l00613"></a>00613 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gdaf046ce39aa118dab921a407446355b">apr_file_setaside</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> **new_file,
+<a name="l00614"></a>00614                                             <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *old_file,
+<a name="l00615"></a>00615                                             <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
+<a name="l00616"></a>00616 <span class="comment"></span>
+<a name="l00617"></a>00617 <span class="comment">/**</span>
+<a name="l00618"></a>00618 <span class="comment"> * Give the specified apr file handle a new buffer </span>
+<a name="l00619"></a>00619 <span class="comment"> * @param thefile  The file handle that is to be modified</span>
+<a name="l00620"></a>00620 <span class="comment"> * @param buffer   The buffer</span>
+<a name="l00621"></a>00621 <span class="comment"> * @param bufsize  The size of the buffer</span>
+<a name="l00622"></a>00622 <span class="comment"> * @remark It is possible to add a buffer to previously unbuffered</span>
+<a name="l00623"></a>00623 <span class="comment"> *         file handles, the APR_BUFFERED flag will be added to</span>
+<a name="l00624"></a>00624 <span class="comment"> *         the file handle's flags. Likewise, with buffer=NULL and</span>
+<a name="l00625"></a>00625 <span class="comment"> *         bufsize=0 arguments it is possible to make a previously</span>
+<a name="l00626"></a>00626 <span class="comment"> *         buffered file handle unbuffered.</span>
+<a name="l00627"></a>00627 <span class="comment"> */</span>
+<a name="l00628"></a>00628 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gfe4be8c3b62c42535b84d4237bf6e421">apr_file_buffer_set</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile,
+<a name="l00629"></a>00629                                               <span class="keywordtype">char</span> * buffer,
+<a name="l00630"></a>00630                                               apr_size_t bufsize);
+<a name="l00631"></a>00631 <span class="comment"></span>
+<a name="l00632"></a>00632 <span class="comment">/**</span>
+<a name="l00633"></a>00633 <span class="comment"> * Get the size of any buffer for the specified apr file handle </span>
+<a name="l00634"></a>00634 <span class="comment"> * @param thefile  The file handle </span>
+<a name="l00635"></a>00635 <span class="comment"> */</span>
+<a name="l00636"></a>00636 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(apr_size_t) <a class="code" href="group__apr__file__io.html#g42bbb9227095686ea15eb79f99d248a2">apr_file_buffer_size_get</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile);
+<a name="l00637"></a>00637 <span class="comment"></span>
+<a name="l00638"></a>00638 <span class="comment">/**</span>
+<a name="l00639"></a>00639 <span class="comment"> * Move the read/write file offset to a specified byte within a file.</span>
+<a name="l00640"></a>00640 <span class="comment"> * @param thefile The file descriptor</span>
+<a name="l00641"></a>00641 <span class="comment"> * @param where How to move the pointer, one of:</span>
+<a name="l00642"></a>00642 <span class="comment"> * &lt;PRE&gt;</span>
+<a name="l00643"></a>00643 <span class="comment"> *            APR_SET  --  set the offset to offset</span>
+<a name="l00644"></a>00644 <span class="comment"> *            APR_CUR  --  add the offset to the current position </span>
+<a name="l00645"></a>00645 <span class="comment"> *            APR_END  --  add the offset to the current file size </span>
+<a name="l00646"></a>00646 <span class="comment"> * &lt;/PRE&gt;</span>
+<a name="l00647"></a>00647 <span class="comment"> * @param offset The offset to move the pointer to.</span>
+<a name="l00648"></a>00648 <span class="comment"> * @remark The third argument is modified to be the offset the pointer</span>
+<a name="l00649"></a>00649 <span class="comment">          was actually moved to.</span>
+<a name="l00650"></a>00650 <span class="comment"> */</span>
+<a name="l00651"></a>00651 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g9db84bec24db97a53890df1a6aff63a1">apr_file_seek</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile, 
+<a name="l00652"></a>00652                                    apr_seek_where_t where,
+<a name="l00653"></a>00653                                    apr_off_t *offset);
+<a name="l00654"></a>00654 <span class="comment"></span>
+<a name="l00655"></a>00655 <span class="comment">/**</span>
+<a name="l00656"></a>00656 <span class="comment"> * Create an anonymous pipe.</span>
+<a name="l00657"></a>00657 <span class="comment"> * @param in The newly created pipe's file for reading.</span>
+<a name="l00658"></a>00658 <span class="comment"> * @param out The newly created pipe's file for writing.</span>
+<a name="l00659"></a>00659 <span class="comment"> * @param pool The pool to operate on.</span>
+<a name="l00660"></a>00660 <span class="comment"> * @remark By default, the returned file descriptors will be inherited</span>
+<a name="l00661"></a>00661 <span class="comment"> * by child processes created using apr_proc_create().  This can be</span>
+<a name="l00662"></a>00662 <span class="comment"> * changed using apr_file_inherit_unset().</span>
+<a name="l00663"></a>00663 <span class="comment"> * @bug  Some platforms cannot toggle between blocking and nonblocking,</span>
+<a name="l00664"></a>00664 <span class="comment"> * and when passing a pipe as a standard handle to an application which</span>
+<a name="l00665"></a>00665 <span class="comment"> * does not expect it, a non-blocking stream will fluxor the client app.</span>
+<a name="l00666"></a>00666 <span class="comment"> * @deprecated @see apr_file_pipe_create_ex</span>
+<a name="l00667"></a>00667 <span class="comment"> */</span>
+<a name="l00668"></a>00668 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gae3b81342d239c58c351cf11190740ed">apr_file_pipe_create</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> **in, 
+<a name="l00669"></a>00669                                                <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> **out,
+<a name="l00670"></a>00670                                                <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
+<a name="l00671"></a>00671 <span class="comment"></span>
+<a name="l00672"></a>00672 <span class="comment">/**</span>
+<a name="l00673"></a>00673 <span class="comment"> * Create an anonymous pipe which portably supports async timeout options.</span>
+<a name="l00674"></a>00674 <span class="comment"> * @param in The newly created pipe's file for reading.</span>
+<a name="l00675"></a>00675 <span class="comment"> * @param out The newly created pipe's file for writing.</span>
+<a name="l00676"></a>00676 <span class="comment"> * @param blocking one of these values defined in apr_thread_proc.h;</span>
+<a name="l00677"></a>00677 <span class="comment"> * &lt;pre&gt;</span>
+<a name="l00678"></a>00678 <span class="comment"> *       APR_FULL_BLOCK</span>
+<a name="l00679"></a>00679 <span class="comment"> *       APR_READ_BLOCK</span>
+<a name="l00680"></a>00680 <span class="comment"> *       APR_WRITE_BLOCK</span>
+<a name="l00681"></a>00681 <span class="comment"> *       APR_FULL_NONBLOCK</span>
+<a name="l00682"></a>00682 <span class="comment"> * &lt;/pre&gt;</span>
+<a name="l00683"></a>00683 <span class="comment"> * @remark By default, the returned file descriptors will be inherited</span>
+<a name="l00684"></a>00684 <span class="comment"> * by child processes created using apr_proc_create().  This can be</span>
+<a name="l00685"></a>00685 <span class="comment"> * changed using apr_file_inherit_unset().</span>
+<a name="l00686"></a>00686 <span class="comment"> * @remark Some platforms cannot toggle between blocking and nonblocking,</span>
+<a name="l00687"></a>00687 <span class="comment"> * and when passing a pipe as a standard handle to an application which</span>
+<a name="l00688"></a>00688 <span class="comment"> * does not expect it, a non-blocking stream will fluxor the client app.</span>
+<a name="l00689"></a>00689 <span class="comment"> * Use this function rather than apr_file_pipe_create to create pipes </span>
+<a name="l00690"></a>00690 <span class="comment"> * where one or both ends require non-blocking semantics.</span>
+<a name="l00691"></a>00691 <span class="comment"> */</span>
+<a name="l00692"></a>00692 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gc365ab74c583eb1df5cd05660a81b5c8">apr_file_pipe_create_ex</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> **in, 
+<a name="l00693"></a>00693                                                   <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> **out, 
+<a name="l00694"></a>00694                                                   apr_int32_t blocking, 
+<a name="l00695"></a>00695                                                   <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
+<a name="l00696"></a>00696 <span class="comment"></span>
+<a name="l00697"></a>00697 <span class="comment">/**</span>
+<a name="l00698"></a>00698 <span class="comment"> * Create a named pipe.</span>
+<a name="l00699"></a>00699 <span class="comment"> * @param filename The filename of the named pipe</span>
+<a name="l00700"></a>00700 <span class="comment"> * @param perm The permissions for the newly created pipe.</span>
+<a name="l00701"></a>00701 <span class="comment"> * @param pool The pool to operate on.</span>
+<a name="l00702"></a>00702 <span class="comment"> */</span>
+<a name="l00703"></a>00703 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g60cec3e6717bab0f11577bd7c38b4c59">apr_file_namedpipe_create</a>(const <span class="keywordtype">char</span> *filename, 
+<a name="l00704"></a>00704                                                     <a class="code" href="group__apr__file__info.html#g3af19c4c47007169064a70f9351bc7d8">apr_fileperms_t</a> perm, 
+<a name="l00705"></a>00705                                                     <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
+<a name="l00706"></a>00706 <span class="comment"></span>
+<a name="l00707"></a>00707 <span class="comment">/**</span>
+<a name="l00708"></a>00708 <span class="comment"> * Get the timeout value for a pipe or manipulate the blocking state.</span>
+<a name="l00709"></a>00709 <span class="comment"> * @param thepipe The pipe we are getting a timeout for.</span>
+<a name="l00710"></a>00710 <span class="comment"> * @param timeout The current timeout value in microseconds. </span>
+<a name="l00711"></a>00711 <span class="comment"> */</span>
+<a name="l00712"></a>00712 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g90e481207a38df04818a0c55883ee953">apr_file_pipe_timeout_get</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thepipe, 
+<a name="l00713"></a>00713                                                <a class="code" href="group__apr__time.html#gae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a> *timeout);
+<a name="l00714"></a>00714 <span class="comment"></span>
+<a name="l00715"></a>00715 <span class="comment">/**</span>
+<a name="l00716"></a>00716 <span class="comment"> * Set the timeout value for a pipe or manipulate the blocking state.</span>
+<a name="l00717"></a>00717 <span class="comment"> * @param thepipe The pipe we are setting a timeout on.</span>
+<a name="l00718"></a>00718 <span class="comment"> * @param timeout The timeout value in microseconds.  Values &lt; 0 mean wait </span>
+<a name="l00719"></a>00719 <span class="comment"> *        forever, 0 means do not wait at all.</span>
+<a name="l00720"></a>00720 <span class="comment"> */</span>
+<a name="l00721"></a>00721 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gf88d2fca768e3fa9f28ea010e1bf602a">apr_file_pipe_timeout_set</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thepipe, 
+<a name="l00722"></a>00722                                                   <a class="code" href="group__apr__time.html#gae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a> timeout);
+<a name="l00723"></a>00723 <span class="comment"></span>
+<a name="l00724"></a>00724 <span class="comment">/** file (un)locking functions. */</span>
+<a name="l00725"></a>00725 <span class="comment"></span>
+<a name="l00726"></a>00726 <span class="comment">/**</span>
+<a name="l00727"></a>00727 <span class="comment"> * Establish a lock on the specified, open file. The lock may be advisory</span>
+<a name="l00728"></a>00728 <span class="comment"> * or mandatory, at the discretion of the platform. The lock applies to</span>
+<a name="l00729"></a>00729 <span class="comment"> * the file as a whole, rather than a specific range. Locks are established</span>
+<a name="l00730"></a>00730 <span class="comment"> * on a per-thread/process basis; a second lock by the same thread will not</span>
+<a name="l00731"></a>00731 <span class="comment"> * block.</span>
+<a name="l00732"></a>00732 <span class="comment"> * @param thefile The file to lock.</span>
+<a name="l00733"></a>00733 <span class="comment"> * @param type The type of lock to establish on the file.</span>
+<a name="l00734"></a>00734 <span class="comment"> */</span>
+<a name="l00735"></a>00735 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g2d337e66c1fa0cd433164079bf542484">apr_file_lock</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile, <span class="keywordtype">int</span> type);
+<a name="l00736"></a>00736 <span class="comment"></span>
+<a name="l00737"></a>00737 <span class="comment">/**</span>
+<a name="l00738"></a>00738 <span class="comment"> * Remove any outstanding locks on the file.</span>
+<a name="l00739"></a>00739 <span class="comment"> * @param thefile The file to unlock.</span>
+<a name="l00740"></a>00740 <span class="comment"> */</span>
+<a name="l00741"></a>00741 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g3a255996fb439b6d66ed7cd65319525b">apr_file_unlock</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile);
+<a name="l00742"></a>00742 <span class="comment"></span>
+<a name="l00743"></a>00743 <span class="comment">/**accessor and general file_io functions. */</span>
+<a name="l00744"></a>00744 <span class="comment"></span>
+<a name="l00745"></a>00745 <span class="comment">/**</span>
+<a name="l00746"></a>00746 <span class="comment"> * return the file name of the current file.</span>
+<a name="l00747"></a>00747 <span class="comment"> * @param new_path The path of the file.  </span>
+<a name="l00748"></a>00748 <span class="comment"> * @param thefile The currently open file.</span>
+<a name="l00749"></a>00749 <span class="comment"> */</span>                     
+<a name="l00750"></a>00750 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g5c750a88fe1e032e1d85d3db40d9519f">apr_file_name_get</a>(const <span class="keywordtype">char</span> **new_path, 
+<a name="l00751"></a>00751                                             <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile);
+<a name="l00752"></a>00752     <span class="comment"></span>
+<a name="l00753"></a>00753 <span class="comment">/**</span>
+<a name="l00754"></a>00754 <span class="comment"> * Return the data associated with the current file.</span>
+<a name="l00755"></a>00755 <span class="comment"> * @param data The user data associated with the file.  </span>
+<a name="l00756"></a>00756 <span class="comment"> * @param key The key to use for retreiving data associated with this file.</span>
+<a name="l00757"></a>00757 <span class="comment"> * @param file The currently open file.</span>
+<a name="l00758"></a>00758 <span class="comment"> */</span>                     
+<a name="l00759"></a>00759 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gfa13b7024748a7e45344d6998ddbd281">apr_file_data_get</a>(<span class="keywordtype">void</span> **data, const <span class="keywordtype">char</span> *key, 
+<a name="l00760"></a>00760                                             <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *file);
+<a name="l00761"></a>00761 <span class="comment"></span>
+<a name="l00762"></a>00762 <span class="comment">/**</span>
+<a name="l00763"></a>00763 <span class="comment"> * Set the data associated with the current file.</span>
+<a name="l00764"></a>00764 <span class="comment"> * @param file The currently open file.</span>
+<a name="l00765"></a>00765 <span class="comment"> * @param data The user data to associate with the file.  </span>
+<a name="l00766"></a>00766 <span class="comment"> * @param key The key to use for assocaiteing data with the file.</span>
+<a name="l00767"></a>00767 <span class="comment"> * @param cleanup The cleanup routine to use when the file is destroyed.</span>
+<a name="l00768"></a>00768 <span class="comment"> */</span>                     
+<a name="l00769"></a>00769 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g58c857162593d8b3aa999df5b7af0805">apr_file_data_set</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *file, <span class="keywordtype">void</span> *data,
+<a name="l00770"></a>00770                                             const <span class="keywordtype">char</span> *key,
+<a name="l00771"></a>00771                                             <a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*cleanup)(<span class="keywordtype">void</span> *));
+<a name="l00772"></a>00772 <span class="comment"></span>
+<a name="l00773"></a>00773 <span class="comment">/**</span>
+<a name="l00774"></a>00774 <span class="comment"> * Write a string to a file using a printf format.</span>
+<a name="l00775"></a>00775 <span class="comment"> * @param fptr The file to write to.</span>
+<a name="l00776"></a>00776 <span class="comment"> * @param format The format string</span>
+<a name="l00777"></a>00777 <span class="comment"> * @param ... The values to substitute in the format string</span>
+<a name="l00778"></a>00778 <span class="comment"> * @return The number of bytes written</span>
+<a name="l00779"></a>00779 <span class="comment"> */</span> 
+<a name="l00780"></a>00780 <a class="code" href="group__apr__platform.html#g3ad5e45fabbda0ec5f106c334f1a0ae5">APR_DECLARE_NONSTD</a>(<span class="keywordtype">int</span>) <a class="code" href="group__apr__file__io.html#g29fca4b0201c236856fea5578f410c0e">apr_file_printf</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *fptr, 
+<a name="l00781"></a>00781                                         const <span class="keywordtype">char</span> *format, ...)
+<a name="l00782"></a>00782         __attribute__((format(printf,2,3)));
+<a name="l00783"></a>00783 <span class="comment"></span>
+<a name="l00784"></a>00784 <span class="comment">/**</span>
+<a name="l00785"></a>00785 <span class="comment"> * set the specified file's permission bits.</span>
+<a name="l00786"></a>00786 <span class="comment"> * @param fname The file (name) to apply the permissions to.</span>
+<a name="l00787"></a>00787 <span class="comment"> * @param perms The permission bits to apply to the file.</span>
+<a name="l00788"></a>00788 <span class="comment"> *</span>
+<a name="l00789"></a>00789 <span class="comment"> * @warning Some platforms may not be able to apply all of the</span>
+<a name="l00790"></a>00790 <span class="comment"> * available permission bits; APR_INCOMPLETE will be returned if some</span>
+<a name="l00791"></a>00791 <span class="comment"> * permissions are specified which could not be set.</span>
+<a name="l00792"></a>00792 <span class="comment"> *</span>
+<a name="l00793"></a>00793 <span class="comment"> * @warning Platforms which do not implement this feature will return</span>
+<a name="l00794"></a>00794 <span class="comment"> * APR_ENOTIMPL.</span>
+<a name="l00795"></a>00795 <span class="comment"> */</span>
+<a name="l00796"></a>00796 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gc5fed6d75597476718c40fc603823b1e">apr_file_perms_set</a>(const <span class="keywordtype">char</span> *fname,
+<a name="l00797"></a>00797                                              <a class="code" href="group__apr__file__info.html#g3af19c4c47007169064a70f9351bc7d8">apr_fileperms_t</a> perms);
+<a name="l00798"></a>00798 <span class="comment"></span>
+<a name="l00799"></a>00799 <span class="comment">/**</span>
+<a name="l00800"></a>00800 <span class="comment"> * Set attributes of the specified file.</span>
+<a name="l00801"></a>00801 <span class="comment"> * @param fname The full path to the file (using / on all systems)</span>
+<a name="l00802"></a>00802 <span class="comment"> * @param attributes Or'd combination of</span>
+<a name="l00803"></a>00803 <span class="comment"> * &lt;PRE&gt;</span>
+<a name="l00804"></a>00804 <span class="comment"> *            APR_FILE_ATTR_READONLY   - make the file readonly</span>
+<a name="l00805"></a>00805 <span class="comment"> *            APR_FILE_ATTR_EXECUTABLE - make the file executable</span>
+<a name="l00806"></a>00806 <span class="comment"> *            APR_FILE_ATTR_HIDDEN     - make the file hidden</span>
+<a name="l00807"></a>00807 <span class="comment"> * &lt;/PRE&gt;</span>
+<a name="l00808"></a>00808 <span class="comment"> * @param attr_mask Mask of valid bits in attributes.</span>
+<a name="l00809"></a>00809 <span class="comment"> * @param pool the pool to use.</span>
+<a name="l00810"></a>00810 <span class="comment"> * @remark This function should be used in preference to explict manipulation</span>
+<a name="l00811"></a>00811 <span class="comment"> *      of the file permissions, because the operations to provide these</span>
+<a name="l00812"></a>00812 <span class="comment"> *      attributes are platform specific and may involve more than simply</span>
+<a name="l00813"></a>00813 <span class="comment"> *      setting permission bits.</span>
+<a name="l00814"></a>00814 <span class="comment"> * @warning Platforms which do not implement this feature will return</span>
+<a name="l00815"></a>00815 <span class="comment"> *      APR_ENOTIMPL.</span>
+<a name="l00816"></a>00816 <span class="comment"> */</span>
+<a name="l00817"></a>00817 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g96ceec3492ad0c75d2b58c167087ee6a">apr_file_attrs_set</a>(const <span class="keywordtype">char</span> *fname,
+<a name="l00818"></a>00818                                              apr_fileattrs_t attributes,
+<a name="l00819"></a>00819                                              apr_fileattrs_t attr_mask,
 <a name="l00820"></a>00820                                              <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
 <a name="l00821"></a>00821 <span class="comment"></span>
 <a name="l00822"></a>00822 <span class="comment">/**</span>
-<a name="l00823"></a>00823 <span class="comment"> * Create a new directory on the file system.</span>
-<a name="l00824"></a>00824 <span class="comment"> * @param path the path for the directory to be created. (use / on all systems)</span>
-<a name="l00825"></a>00825 <span class="comment"> * @param perm Permissions for the new direcoty.</span>
-<a name="l00826"></a>00826 <span class="comment"> * @param pool the pool to use.</span>
-<a name="l00827"></a>00827 <span class="comment"> */</span>                        
-<a name="l00828"></a>00828 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g51e0b4703c7561f72587982808985d29">apr_dir_make</a>(const <span class="keywordtype">char</span> *path, <a class="code" href="group__apr__file__info.html#g3af19c4c47007169064a70f9351bc7d8">apr_fileperms_t</a> perm, 
-<a name="l00829"></a>00829                                        <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
-<a name="l00830"></a>00830 <span class="comment"></span>
-<a name="l00831"></a>00831 <span class="comment">/** Creates a new directory on the file system, but behaves like</span>
-<a name="l00832"></a>00832 <span class="comment"> * 'mkdir -p'. Creates intermediate directories as required. No error</span>
-<a name="l00833"></a>00833 <span class="comment"> * will be reported if PATH already exists.</span>
-<a name="l00834"></a>00834 <span class="comment"> * @param path the path for the directory to be created. (use / on all systems)</span>
-<a name="l00835"></a>00835 <span class="comment"> * @param perm Permissions for the new direcoty.</span>
-<a name="l00836"></a>00836 <span class="comment"> * @param pool the pool to use.</span>
-<a name="l00837"></a>00837 <span class="comment"> */</span>
-<a name="l00838"></a>00838 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g6a3b2602f57ff148cd64096da02adbd2">apr_dir_make_recursive</a>(const <span class="keywordtype">char</span> *path,
-<a name="l00839"></a>00839                                                  <a class="code" href="group__apr__file__info.html#g3af19c4c47007169064a70f9351bc7d8">apr_fileperms_t</a> perm,
-<a name="l00840"></a>00840                                                  <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
-<a name="l00841"></a>00841 <span class="comment"></span>
-<a name="l00842"></a>00842 <span class="comment">/**</span>
-<a name="l00843"></a>00843 <span class="comment"> * Remove directory from the file system.</span>
-<a name="l00844"></a>00844 <span class="comment"> * @param path the path for the directory to be removed. (use / on all systems)</span>
-<a name="l00845"></a>00845 <span class="comment"> * @param pool the pool to use.</span>
-<a name="l00846"></a>00846 <span class="comment"> * @remark Removing a directory which is in-use (e.g., the current working</span>
-<a name="l00847"></a>00847 <span class="comment"> * directory, or during apr_dir_read, or with an open file) is not portable.</span>
-<a name="l00848"></a>00848 <span class="comment"> */</span>                        
-<a name="l00849"></a>00849 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g5487d02a62fba9444747ccb5838150ba">apr_dir_remove</a>(const <span class="keywordtype">char</span> *path, <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
-<a name="l00850"></a>00850 <span class="comment"></span>
-<a name="l00851"></a>00851 <span class="comment">/**</span>
-<a name="l00852"></a>00852 <span class="comment"> * get the specified file's stats.</span>
-<a name="l00853"></a>00853 <span class="comment"> * @param finfo Where to store the information about the file.</span>
-<a name="l00854"></a>00854 <span class="comment"> * @param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ values </span>
-<a name="l00855"></a>00855 <span class="comment"> * @param thefile The file to get information about.</span>
-<a name="l00856"></a>00856 <span class="comment"> */</span> 
-<a name="l00857"></a>00857 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g39be7fe05d0dda4a28f4358b61a44ac8">apr_file_info_get</a>(<a class="code" href="structapr__finfo__t.html">apr_finfo_t</a> *finfo, 
-<a name="l00858"></a>00858                                             apr_int32_t wanted,
-<a name="l00859"></a>00859                                             <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile);
-<a name="l00860"></a>00860     
-<a name="l00861"></a>00861 <span class="comment"></span>
-<a name="l00862"></a>00862 <span class="comment">/**</span>
-<a name="l00863"></a>00863 <span class="comment"> * Truncate the file's length to the specified offset</span>
-<a name="l00864"></a>00864 <span class="comment"> * @param fp The file to truncate</span>
-<a name="l00865"></a>00865 <span class="comment"> * @param offset The offset to truncate to.</span>
-<a name="l00866"></a>00866 <span class="comment"> * @remark The read/write file offset is repositioned to offset.</span>
-<a name="l00867"></a>00867 <span class="comment"> */</span>
-<a name="l00868"></a>00868 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gc067fe5f208c927cf6d213197b9335a8">apr_file_trunc</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *fp, apr_off_t offset);
-<a name="l00869"></a>00869 <span class="comment"></span>
-<a name="l00870"></a>00870 <span class="comment">/**</span>
-<a name="l00871"></a>00871 <span class="comment"> * Retrieve the flags that were passed into apr_file_open()</span>
-<a name="l00872"></a>00872 <span class="comment"> * when the file was opened.</span>
-<a name="l00873"></a>00873 <span class="comment"> * @return apr_int32_t the flags</span>
-<a name="l00874"></a>00874 <span class="comment"> */</span>
-<a name="l00875"></a>00875 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(apr_int32_t) <a class="code" href="group__apr__file__io.html#g023d6e4d2512382a9d4b1f881e105b8f">apr_file_flags_get</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *f);
-<a name="l00876"></a>00876 <span class="comment"></span>
-<a name="l00877"></a>00877 <span class="comment">/**</span>
-<a name="l00878"></a>00878 <span class="comment"> * Get the pool used by the file.</span>
+<a name="l00823"></a>00823 <span class="comment"> * Set the mtime of the specified file.</span>
+<a name="l00824"></a>00824 <span class="comment"> * @param fname The full path to the file (using / on all systems)</span>
+<a name="l00825"></a>00825 <span class="comment"> * @param mtime The mtime to apply to the file.</span>
+<a name="l00826"></a>00826 <span class="comment"> * @param pool The pool to use.</span>
+<a name="l00827"></a>00827 <span class="comment"> * @warning Platforms which do not implement this feature will return</span>
+<a name="l00828"></a>00828 <span class="comment"> *      APR_ENOTIMPL.</span>
+<a name="l00829"></a>00829 <span class="comment"> */</span>
+<a name="l00830"></a>00830 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g79f58458a00a4072622005c09ed8f96f">apr_file_mtime_set</a>(const <span class="keywordtype">char</span> *fname,
+<a name="l00831"></a>00831                                              <a class="code" href="group__apr__time.html#gdb4bde16055748190eae190c55aa02bb">apr_time_t</a> mtime,
+<a name="l00832"></a>00832                                              <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
+<a name="l00833"></a>00833 <span class="comment"></span>
+<a name="l00834"></a>00834 <span class="comment">/**</span>
+<a name="l00835"></a>00835 <span class="comment"> * Create a new directory on the file system.</span>
+<a name="l00836"></a>00836 <span class="comment"> * @param path the path for the directory to be created. (use / on all systems)</span>
+<a name="l00837"></a>00837 <span class="comment"> * @param perm Permissions for the new direcoty.</span>
+<a name="l00838"></a>00838 <span class="comment"> * @param pool the pool to use.</span>
+<a name="l00839"></a>00839 <span class="comment"> */</span>                        
+<a name="l00840"></a>00840 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g51e0b4703c7561f72587982808985d29">apr_dir_make</a>(const <span class="keywordtype">char</span> *path, <a class="code" href="group__apr__file__info.html#g3af19c4c47007169064a70f9351bc7d8">apr_fileperms_t</a> perm, 
+<a name="l00841"></a>00841                                        <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
+<a name="l00842"></a>00842 <span class="comment"></span>
+<a name="l00843"></a>00843 <span class="comment">/** Creates a new directory on the file system, but behaves like</span>
+<a name="l00844"></a>00844 <span class="comment"> * 'mkdir -p'. Creates intermediate directories as required. No error</span>
+<a name="l00845"></a>00845 <span class="comment"> * will be reported if PATH already exists.</span>
+<a name="l00846"></a>00846 <span class="comment"> * @param path the path for the directory to be created. (use / on all systems)</span>
+<a name="l00847"></a>00847 <span class="comment"> * @param perm Permissions for the new direcoty.</span>
+<a name="l00848"></a>00848 <span class="comment"> * @param pool the pool to use.</span>
+<a name="l00849"></a>00849 <span class="comment"> */</span>
+<a name="l00850"></a>00850 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g6a3b2602f57ff148cd64096da02adbd2">apr_dir_make_recursive</a>(const <span class="keywordtype">char</span> *path,
+<a name="l00851"></a>00851                                                  <a class="code" href="group__apr__file__info.html#g3af19c4c47007169064a70f9351bc7d8">apr_fileperms_t</a> perm,
+<a name="l00852"></a>00852                                                  <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
+<a name="l00853"></a>00853 <span class="comment"></span>
+<a name="l00854"></a>00854 <span class="comment">/**</span>
+<a name="l00855"></a>00855 <span class="comment"> * Remove directory from the file system.</span>
+<a name="l00856"></a>00856 <span class="comment"> * @param path the path for the directory to be removed. (use / on all systems)</span>
+<a name="l00857"></a>00857 <span class="comment"> * @param pool the pool to use.</span>
+<a name="l00858"></a>00858 <span class="comment"> * @remark Removing a directory which is in-use (e.g., the current working</span>
+<a name="l00859"></a>00859 <span class="comment"> * directory, or during apr_dir_read, or with an open file) is not portable.</span>
+<a name="l00860"></a>00860 <span class="comment"> */</span>                        
+<a name="l00861"></a>00861 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g5487d02a62fba9444747ccb5838150ba">apr_dir_remove</a>(const <span class="keywordtype">char</span> *path, <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
+<a name="l00862"></a>00862 <span class="comment"></span>
+<a name="l00863"></a>00863 <span class="comment">/**</span>
+<a name="l00864"></a>00864 <span class="comment"> * get the specified file's stats.</span>
+<a name="l00865"></a>00865 <span class="comment"> * @param finfo Where to store the information about the file.</span>
+<a name="l00866"></a>00866 <span class="comment"> * @param wanted The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ values </span>
+<a name="l00867"></a>00867 <span class="comment"> * @param thefile The file to get information about.</span>
+<a name="l00868"></a>00868 <span class="comment"> */</span> 
+<a name="l00869"></a>00869 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g39be7fe05d0dda4a28f4358b61a44ac8">apr_file_info_get</a>(<a class="code" href="structapr__finfo__t.html">apr_finfo_t</a> *finfo, 
+<a name="l00870"></a>00870                                             apr_int32_t wanted,
+<a name="l00871"></a>00871                                             <a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *thefile);
+<a name="l00872"></a>00872     
+<a name="l00873"></a>00873 <span class="comment"></span>
+<a name="l00874"></a>00874 <span class="comment">/**</span>
+<a name="l00875"></a>00875 <span class="comment"> * Truncate the file's length to the specified offset</span>
+<a name="l00876"></a>00876 <span class="comment"> * @param fp The file to truncate</span>
+<a name="l00877"></a>00877 <span class="comment"> * @param offset The offset to truncate to.</span>
+<a name="l00878"></a>00878 <span class="comment"> * @remark The read/write file offset is repositioned to offset.</span>
 <a name="l00879"></a>00879 <span class="comment"> */</span>
-<a name="l00880"></a>00880 <a class="code" href="group__apr__pools.html#g89ce1d55c7f0c39ea87c88eabd655394">APR_POOL_DECLARE_ACCESSOR</a>(file);
+<a name="l00880"></a>00880 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gc067fe5f208c927cf6d213197b9335a8">apr_file_trunc</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *fp, apr_off_t offset);
 <a name="l00881"></a>00881 <span class="comment"></span>
 <a name="l00882"></a>00882 <span class="comment">/**</span>
-<a name="l00883"></a>00883 <span class="comment"> * Set a file to be inherited by child processes.</span>
-<a name="l00884"></a>00884 <span class="comment"> *</span>
-<a name="l00885"></a>00885 <span class="comment"> */</span>
-<a name="l00886"></a>00886 <a class="code" href="apr__inherit_8h.html#a67d345784df8cce8114086e1f67cf3d">APR_DECLARE_INHERIT_SET</a>(file);
-<a name="l00887"></a>00887 <span class="comment"></span>
-<a name="l00888"></a>00888 <span class="comment">/**</span>
-<a name="l00889"></a>00889 <span class="comment"> * Unset a file from being inherited by child processes.</span>
-<a name="l00890"></a>00890 <span class="comment"> */</span>
-<a name="l00891"></a>00891 <a class="code" href="apr__inherit_8h.html#d4886be514d6cead6bd119a48984d4b5">APR_DECLARE_INHERIT_UNSET</a>(file);
-<a name="l00892"></a>00892 <span class="comment"></span>
-<a name="l00893"></a>00893 <span class="comment">/**</span>
-<a name="l00894"></a>00894 <span class="comment"> * Open a temporary file</span>
-<a name="l00895"></a>00895 <span class="comment"> * @param fp The apr file to use as a temporary file.</span>
-<a name="l00896"></a>00896 <span class="comment"> * @param templ The template to use when creating a temp file.</span>
-<a name="l00897"></a>00897 <span class="comment"> * @param flags The flags to open the file with. If this is zero,</span>
-<a name="l00898"></a>00898 <span class="comment"> *              the file is opened with </span>
-<a name="l00899"></a>00899 <span class="comment"> *              APR_CREATE | APR_READ | APR_WRITE | APR_EXCL | APR_DELONCLOSE</span>
-<a name="l00900"></a>00900 <span class="comment"> * @param p The pool to allocate the file out of.</span>
-<a name="l00901"></a>00901 <span class="comment"> * @remark   </span>
-<a name="l00902"></a>00902 <span class="comment"> * This function  generates  a unique temporary file name from template.  </span>
-<a name="l00903"></a>00903 <span class="comment"> * The last six characters of template must be XXXXXX and these are replaced </span>
-<a name="l00904"></a>00904 <span class="comment"> * with a string that makes the filename unique. Since it will  be  modified,</span>
-<a name="l00905"></a>00905 <span class="comment"> * template must not be a string constant, but should be declared as a character</span>
-<a name="l00906"></a>00906 <span class="comment"> * array.  </span>
-<a name="l00907"></a>00907 <span class="comment"> *</span>
-<a name="l00908"></a>00908 <span class="comment"> */</span>
-<a name="l00909"></a>00909 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#gc34981f9ff41f85e4377a6dde185fe52">apr_file_mktemp</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> **fp, <span class="keywordtype">char</span> *templ,
-<a name="l00910"></a>00910                                           apr_int32_t flags, <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
-<a name="l00911"></a>00911 
-<a name="l00912"></a>00912 <span class="comment"></span>
-<a name="l00913"></a>00913 <span class="comment">/**</span>
-<a name="l00914"></a>00914 <span class="comment"> * Find an existing directory suitable as a temporary storage location.</span>
-<a name="l00915"></a>00915 <span class="comment"> * @param temp_dir The temp directory.</span>
-<a name="l00916"></a>00916 <span class="comment"> * @param p The pool to use for any necessary allocations.</span>
-<a name="l00917"></a>00917 <span class="comment"> * @remark   </span>
-<a name="l00918"></a>00918 <span class="comment"> * This function uses an algorithm to search for a directory that an</span>
-<a name="l00919"></a>00919 <span class="comment"> * an application can use for temporary storage.</span>
-<a name="l00920"></a>00920 <span class="comment"> *</span>
-<a name="l00921"></a>00921 <span class="comment"> */</span>
-<a name="l00922"></a>00922 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__file__io.html#g5cc19828a668c362be0ad7a12b805cc0">apr_temp_dir_get</a>(const <span class="keywordtype">char</span> **temp_dir, 
-<a name="l00923"></a>00923                                            <a class="code" href="group__apr__pools.html#gf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p);
+<a name="l00883"></a>00883 <span class="comment"> * Retrieve the flags that were passed into apr_file_open()</span>
+<a name="l00884"></a>00884 <span class="comment"> * when the file was opened.</span>
+<a name="l00885"></a>00885 <span class="comment"> * @return apr_int32_t the flags</span>
+<a name="l00886"></a>00886 <span class="comment"> */</span>
+<a name="l00887"></a>00887 <a class="code" href="group__apr__platform.html#gd7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(apr_int32_t) <a class="code" href="group__apr__file__io.html#g023d6e4d2512382a9d4b1f881e105b8f">apr_file_flags_get</a>(<a class="code" href="group__apr__file__io.html#ga46e4763ac375ea3c7a43ba6f6099e22">apr_file_t</a> *f);
+<a name="l00888"></a>00888 <span class="comment"></span>
+<a name="l00889"></a>00889 <span class="comment">/**</span>
+<a name="l00890"></a>00890 <span class="comment"> * Get the pool used by the file.</span>
+<a name="l00891"></a>00891 <span class="comment"> */</span>
+<a name="l00892"></a>00892 <a class="code" href="group__apr__pools.html#g89ce1d55c7f0c39ea87c88eabd655394">APR_POOL_DECLARE_ACCESSOR</a>(file);
+<a name="l00893"></a>00893 <span class="comment"></span>
+<a name="l00894"></a>00894 <span class="comment">/**</span>
+<a name="l00895"></a>00895 <span class="comment"> * Set a file to be inherited by child processes.</span>
+<a name="l00896"></a>00896 <span class="comment"> *</span>
+<a name="l00897"></a>00897 <span class="comment"> */</span>
+<a name="l00898"></a>00898 <a class="code" href="apr__inherit_8h.html#a67d345784df8cce8114086e1f67cf3d">APR_DECLARE_INHERIT_SET</a>(file);
+<a name="l00899"></a>00899 <span class="comment"></span>
+<a name="l00900"></a>00900 <span class="comment">/**</span>
+<a name="l00901"></a>00901 <span class="comment"> * Unset a file from being inherited by child processes.</span>
+<a name="l00902"></a>00902 <span class="comment"> */</span>
+<a name="l00903"></a>00903 <a class="code" href="apr__inherit_8h.html#d4886be514d6cead6bd119a48984d4b5">APR_DECLARE_INHERIT_UNSET</a>(file);
+<a name="l00904"></a>00904 <span class="comment"></span>
+<a name="l00905"></a>00905 <span class="comment">/**</span>
+<a name="l00906"></a>00906 <span class="comment"> * Open a temporary file</span>
+<a name="l00907"></a>00907 <span class="comment"> * @param fp The apr file to use as a temporary file.</span>
+<a name="l00908"></a>00908 <span class="comment"> * @param templ The template to use when creating a temp file.</span>
+<a name="l00909"></a>00909 <span class="comment"> * @param flags The flags to open the file with. If this is zero,</span>
+<a name="l00910"></a>00910 <span class="comment"> *              the file is opened with </span>
+<a name="l00911"></a>00911 <span class="comment"> *              APR_CREATE | APR_READ | APR_WRITE | APR_EXCL | APR_DELONCLOSE</span>

[... 48 lines stripped ...]


Mime
View raw message