D7net Mini Sh3LL v1
| Current File : //usr/share/systemd/../doc/libisns0/../libaprutil1-dev/html/group___a_p_r___util___opt.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Portable Runtime Utility Library: Optional Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Apache Portable Runtime Utility Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Optional Functions<div class="ingroups"><a class="el" href="group___a_p_r___util.html">APR Utility Functions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Optional Functions:</div>
<div class="dyncontent">
<div class="center"><img src="group___a_p_r___util___opt.png" border="0" usemap="#group______a__p__r______util______opt" alt=""/></div>
<!-- MAP 0 -->
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga987fcf75505450f1b4ff9d7b3a7ff5d3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___opt.html#ga987fcf75505450f1b4ff9d7b3a7ff5d3">APR_OPTIONAL_FN_TYPE</a>(name)   apr_OFN_##name##_t</td></tr>
<tr class="separator:ga987fcf75505450f1b4ff9d7b3a7ff5d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf3ff372e28978d4ce0be7517ca2fddbd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___opt.html#gaf3ff372e28978d4ce0be7517ca2fddbd">APR_DECLARE_OPTIONAL_FN</a>(ret, name, args)   typedef ret (<a class="el" href="group___a_p_r___util___opt.html#ga987fcf75505450f1b4ff9d7b3a7ff5d3">APR_OPTIONAL_FN_TYPE</a>(name)) args</td></tr>
<tr class="separator:gaf3ff372e28978d4ce0be7517ca2fddbd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab611deabd6e78b5f666071e8cbdcc736"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___opt.html#gab611deabd6e78b5f666071e8cbdcc736">APR_REGISTER_OPTIONAL_FN</a>(name)</td></tr>
<tr class="separator:gab611deabd6e78b5f666071e8cbdcc736"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga35f2df25ca06248d2fdd3e7463446418"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___opt.html#ga35f2df25ca06248d2fdd3e7463446418">APR_RETRIEVE_OPTIONAL_FN</a>(name)   (<a class="el" href="group___a_p_r___util___opt.html#ga987fcf75505450f1b4ff9d7b3a7ff5d3">APR_OPTIONAL_FN_TYPE</a>(name) *)apr_dynamic_fn_retrieve(#name)</td></tr>
<tr class="separator:ga35f2df25ca06248d2fdd3e7463446418"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga97de75995984d044cfed134d692377a3"><td class="memItemLeft" align="right" valign="top">typedef void() </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___opt.html#ga97de75995984d044cfed134d692377a3">apr_opt_fn_t</a>(void)</td></tr>
<tr class="separator:ga97de75995984d044cfed134d692377a3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa9c7d3cc32128521274543c384e9698d"><td class="memItemLeft" align="right" valign="top"><a id="gaa9c7d3cc32128521274543c384e9698d"></a>
void </td><td class="memItemRight" valign="bottom"><b>apr_dynamic_fn_register</b> (const char *szName, <a class="el" href="group___a_p_r___util___opt.html#ga97de75995984d044cfed134d692377a3">apr_opt_fn_t</a> *pfn)</td></tr>
<tr class="separator:gaa9c7d3cc32128521274543c384e9698d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1ecfa6a6ced7332d03b5867735a5e49d"><td class="memItemLeft" align="right" valign="top"><a id="ga1ecfa6a6ced7332d03b5867735a5e49d"></a>
<a class="el" href="group___a_p_r___util___opt.html#ga97de75995984d044cfed134d692377a3">apr_opt_fn_t</a> * </td><td class="memItemRight" valign="bottom"><b>apr_dynamic_fn_retrieve</b> (const char *szName)</td></tr>
<tr class="separator:ga1ecfa6a6ced7332d03b5867735a5e49d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Typesafe registration and retrieval of functions that may not be present (i.e. functions exported by optional modules) </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gaf3ff372e28978d4ce0be7517ca2fddbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf3ff372e28978d4ce0be7517ca2fddbd">◆ </a></span>APR_DECLARE_OPTIONAL_FN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_DECLARE_OPTIONAL_FN</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">ret, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">name, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">args </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   typedef ret (<a class="el" href="group___a_p_r___util___opt.html#ga987fcf75505450f1b4ff9d7b3a7ff5d3">APR_OPTIONAL_FN_TYPE</a>(name)) args</td>
</tr>
</table>
</div><div class="memdoc">
<p>Declare an optional function. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ret</td><td>The return type of the function </td></tr>
<tr><td class="paramname">name</td><td>The name of the function </td></tr>
<tr><td class="paramname">args</td><td>The function arguments (including brackets) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga987fcf75505450f1b4ff9d7b3a7ff5d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga987fcf75505450f1b4ff9d7b3a7ff5d3">◆ </a></span>APR_OPTIONAL_FN_TYPE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_OPTIONAL_FN_TYPE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td>   apr_OFN_##name##_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>The type of an optional function. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the function </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gab611deabd6e78b5f666071e8cbdcc736"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab611deabd6e78b5f666071e8cbdcc736">◆ </a></span>APR_REGISTER_OPTIONAL_FN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_REGISTER_OPTIONAL_FN</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
<div class="line"> APR_OPTIONAL_FN_TYPE(name) *apu__opt = name; \</div>
<div class="line"> apr_dynamic_fn_register(#name,(<a class="code" href="group___a_p_r___util___opt.html#ga97de75995984d044cfed134d692377a3">apr_opt_fn_t</a> *)apu__opt); \</div>
<div class="line">} <span class="keywordflow">while</span> (0)</div>
</div><!-- fragment --><p>Register an optional function. This can be later retrieved, type-safely, by name. Like all global functions, the name must be unique. Note that, confusingly but correctly, the function itself can be static! </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the function </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga35f2df25ca06248d2fdd3e7463446418"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga35f2df25ca06248d2fdd3e7463446418">◆ </a></span>APR_RETRIEVE_OPTIONAL_FN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_RETRIEVE_OPTIONAL_FN</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td>   (<a class="el" href="group___a_p_r___util___opt.html#ga987fcf75505450f1b4ff9d7b3a7ff5d3">APR_OPTIONAL_FN_TYPE</a>(name) *)apr_dynamic_fn_retrieve(#name)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve an optional function. Returns NULL if the function is not present. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the function </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga97de75995984d044cfed134d692377a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga97de75995984d044cfed134d692377a3">◆ </a></span>apr_opt_fn_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void() apr_opt_fn_t(void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>XXX: This doesn't belong here, then! Private function! DO NOT USE! </p>
</div>
</div>
</div><!-- contents -->
<div class="ttc" id="agroup___a_p_r___util___opt_html_ga97de75995984d044cfed134d692377a3"><div class="ttname"><a href="group___a_p_r___util___opt.html#ga97de75995984d044cfed134d692377a3">apr_opt_fn_t</a></div><div class="ttdeci">void() apr_opt_fn_t(void)</div><div class="ttdef"><b>Definition:</b> apr_optional.h:59</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
AnonSec - 2021 | Recode By D7net