Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 42b8e67cd59abacb81e11c7ba39524d1 > files > 260

apr-api-docs-1.4.2-1.fc15.noarch.rpm

<!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: Miscellaneous library routines</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.7.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Apache Portable Runtime</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li id="searchli">
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#define-members">Defines</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<h1>Miscellaneous library routines</h1>  </div>
<div class="ingroups"><a class="el" href="group___a_p_r.html">Apache Portability Runtime library</a></div></div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__general.html#gaa93f0eb578d23995850d61f7d61c55c1">FALSE</a>&#160;&#160;&#160;0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__general.html#gaa8cecfc5c5c054d2875c03e77b7be15d">TRUE</a>&#160;&#160;&#160;(!FALSE)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__general.html#ga60fc208d93123acc7cf915a66e49e654">APR_ASCII_BLANK</a>&#160;&#160;&#160;'\040'</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__general.html#ga91c14ef7f03e82c07f4d3d56f63f8b6a">APR_ASCII_CR</a>&#160;&#160;&#160;'\015'</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__general.html#ga9e76601cef56a7a5b25f73fe6d57d7d9">APR_ASCII_LF</a>&#160;&#160;&#160;'\012'</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__general.html#gac7162c0b5d026a0717aaa98bf581349d">APR_ASCII_TAB</a>&#160;&#160;&#160;'\011'</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__general.html#ga41e537d6ad732766d12cd4eb61531678">APR_OFFSET</a>(p_type, field)&#160;&#160;&#160;((long) (((char *) (&amp;(((p_type)NULL)-&gt;field))) - ((char *) NULL)))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__general.html#gac16b1187b6ea63706c5dd48c88323dec">APR_OFFSETOF</a>(s_type, field)&#160;&#160;&#160;APR_OFFSET(s_type*,field)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__general.html#ga3c4f50d14ebe7a6add282d879521d552">APR_ALIGN</a>(size, boundary)&#160;&#160;&#160;(((size) + ((boundary) - 1)) &amp; ~((boundary) - 1))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__general.html#gab484e98426221f3212fcb67af0467381">APR_ALIGN_DEFAULT</a>(size)&#160;&#160;&#160;APR_ALIGN(size, 8)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__general.html#gae90215615972dfa4108018304361ef0b">APR_STRINGIFY</a>(n)&#160;&#160;&#160;APR_STRINGIFY_HELPER(n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__general.html#ga71918dd8c53e093283b43b0ff0965439">APR_STRINGIFY_HELPER</a>(n)&#160;&#160;&#160;#n</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad12df83f1d3a090b658adc645555ca79"></a><!-- doxytag: member="apr_general::memmove" ref="gad12df83f1d3a090b658adc645555ca79" args="(a, b, c)" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><b>memmove</b>(a, b, c)&#160;&#160;&#160;bcopy(b,a,c)</td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__general.html#gafe9e657d61b61d62ecba34299a82a7ea">apr_signum_t</a></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga16d6b0bd660cc3f9910924c6b6f4af8e"></a><!-- doxytag: member="apr_general::memchr" ref="ga16d6b0bd660cc3f9910924c6b6f4af8e" args="(const void *s, int c, size_t n)" -->
void *&#160;</td><td class="memItemRight" valign="bottom"><b>memchr</b> (const void *s, int c, size_t n)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This is collection of oddballs that didn't fit anywhere else, and might move to more appropriate headers with the release of APR 1.0. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga3c4f50d14ebe7a6add282d879521d552"></a><!-- doxytag: member="apr_general.h::APR_ALIGN" ref="ga3c4f50d14ebe7a6add282d879521d552" args="(size, boundary)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define APR_ALIGN</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">size, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">boundary&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;(((size) + ((boundary) - 1)) &amp; ~((boundary) - 1))</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Alignment macros </p>

</div>
</div>
<a class="anchor" id="gab484e98426221f3212fcb67af0467381"></a><!-- doxytag: member="apr_general.h::APR_ALIGN_DEFAULT" ref="gab484e98426221f3212fcb67af0467381" args="(size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define APR_ALIGN_DEFAULT</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">size</td><td>)</td>
          <td>&#160;&#160;&#160;APR_ALIGN(size, 8)</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default alignment </p>

</div>
</div>
<a class="anchor" id="ga60fc208d93123acc7cf915a66e49e654"></a><!-- doxytag: member="apr_general.h::APR_ASCII_BLANK" ref="ga60fc208d93123acc7cf915a66e49e654" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define APR_ASCII_BLANK&#160;&#160;&#160;'\040'</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>a space </p>

</div>
</div>
<a class="anchor" id="ga91c14ef7f03e82c07f4d3d56f63f8b6a"></a><!-- doxytag: member="apr_general.h::APR_ASCII_CR" ref="ga91c14ef7f03e82c07f4d3d56f63f8b6a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define APR_ASCII_CR&#160;&#160;&#160;'\015'</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>a carrige return </p>

</div>
</div>
<a class="anchor" id="ga9e76601cef56a7a5b25f73fe6d57d7d9"></a><!-- doxytag: member="apr_general.h::APR_ASCII_LF" ref="ga9e76601cef56a7a5b25f73fe6d57d7d9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define APR_ASCII_LF&#160;&#160;&#160;'\012'</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>a line feed </p>

</div>
</div>
<a class="anchor" id="gac7162c0b5d026a0717aaa98bf581349d"></a><!-- doxytag: member="apr_general.h::APR_ASCII_TAB" ref="gac7162c0b5d026a0717aaa98bf581349d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define APR_ASCII_TAB&#160;&#160;&#160;'\011'</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>a tab </p>

</div>
</div>
<a class="anchor" id="ga41e537d6ad732766d12cd4eb61531678"></a><!-- doxytag: member="apr_general.h::APR_OFFSET" ref="ga41e537d6ad732766d12cd4eb61531678" args="(p_type, field)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define APR_OFFSET</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">p_type, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">field&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;((long) (((char *) (&amp;(((p_type)NULL)-&gt;field))) - ((char *) NULL)))</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Finding offsets of elements within structures. Taken from the X code... they've sweated portability of this stuff so we don't have to. Sigh... </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">p_type</td><td>pointer type name </td></tr>
    <tr><td class="paramname">field</td><td>data field within the structure pointed to </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>offset </dd></dl>

</div>
</div>
<a class="anchor" id="gac16b1187b6ea63706c5dd48c88323dec"></a><!-- doxytag: member="apr_general.h::APR_OFFSETOF" ref="gac16b1187b6ea63706c5dd48c88323dec" args="(s_type, field)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define APR_OFFSETOF</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">s_type, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">field&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;APR_OFFSET(s_type*,field)</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Finding offsets of elements within structures. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">s_type</td><td>structure type name </td></tr>
    <tr><td class="paramname">field</td><td>data field within the structure </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>offset </dd></dl>

</div>
</div>
<a class="anchor" id="gae90215615972dfa4108018304361ef0b"></a><!-- doxytag: member="apr_general.h::APR_STRINGIFY" ref="gae90215615972dfa4108018304361ef0b" args="(n)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define APR_STRINGIFY</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">n</td><td>)</td>
          <td>&#160;&#160;&#160;APR_STRINGIFY_HELPER(n)</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>String and memory functions Properly quote a value as a string in the C preprocessor </p>

</div>
</div>
<a class="anchor" id="ga71918dd8c53e093283b43b0ff0965439"></a><!-- doxytag: member="apr_general.h::APR_STRINGIFY_HELPER" ref="ga71918dd8c53e093283b43b0ff0965439" args="(n)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define APR_STRINGIFY_HELPER</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">n</td><td>)</td>
          <td>&#160;&#160;&#160;#n</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Helper macro for APR_STRINGIFY </p>

</div>
</div>
<a class="anchor" id="gaa93f0eb578d23995850d61f7d61c55c1"></a><!-- doxytag: member="apr_general.h::FALSE" ref="gaa93f0eb578d23995850d61f7d61c55c1" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define FALSE&#160;&#160;&#160;0</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>FALSE </p>

</div>
</div>
<a class="anchor" id="gaa8cecfc5c5c054d2875c03e77b7be15d"></a><!-- doxytag: member="apr_general.h::TRUE" ref="gaa8cecfc5c5c054d2875c03e77b7be15d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TRUE&#160;&#160;&#160;(!FALSE)</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>TRUE </p>

</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gafe9e657d61b61d62ecba34299a82a7ea"></a><!-- doxytag: member="apr_general.h::apr_signum_t" ref="gafe9e657d61b61d62ecba34299a82a7ea" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef int <a class="el" href="group__apr__general.html#gafe9e657d61b61d62ecba34299a82a7ea">apr_signum_t</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>signal numbers typedef </p>

</div>
</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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</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 class="footer"><small>Generated on Tue Feb 8 2011 for Apache Portable Runtime by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>