<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Portable Runtime: Library initialization and termination</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Apache Portable Runtime
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Library initialization and termination</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga4a91a6b9ff457ead13e670950127761a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__library.html#ga4a91a6b9ff457ead13e670950127761a">apr_initialize</a> (void)</td></tr>
<tr class="separator:ga4a91a6b9ff457ead13e670950127761a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa1c4fc2e1c814cc5d4cd3d8719288fc9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__library.html#gaa1c4fc2e1c814cc5d4cd3d8719288fc9">apr_app_initialize</a> (int *argc, char const *const **argv, char const *const **env)</td></tr>
<tr class="separator:gaa1c4fc2e1c814cc5d4cd3d8719288fc9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8e96d45ee09fc7e7eb3646efef1424a3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__library.html#ga8e96d45ee09fc7e7eb3646efef1424a3">apr_terminate</a> (void)</td></tr>
<tr class="separator:ga8e96d45ee09fc7e7eb3646efef1424a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga18667a60ff34d6209e519b4a4ce8cad1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__library.html#ga18667a60ff34d6209e519b4a4ce8cad1">apr_terminate2</a> (void)</td></tr>
<tr class="separator:ga18667a60ff34d6209e519b4a4ce8cad1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>String and memory functions </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaa1c4fc2e1c814cc5d4cd3d8719288fc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa1c4fc2e1c814cc5d4cd3d8719288fc9">◆ </a></span>apr_app_initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_app_initialize </td>
<td>(</td>
<td class="paramtype">int * </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const *const ** </td>
<td class="paramname"><em>argv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const *const ** </td>
<td class="paramname"><em>env</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set up an application with normalized argc, argv (and optionally env) in order to deal with platform-specific oddities, such as Win32 services, code pages and signals. This must be the first function called for any APR program. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">argc</td><td>Pointer to the argc that may be corrected </td></tr>
<tr><td class="paramname">argv</td><td>Pointer to the argv that may be corrected </td></tr>
<tr><td class="paramname">env</td><td>Pointer to the env that may be corrected, may be NULL </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>See apr_initialize if this is a library consumer of apr. Otherwise, this call is identical to apr_initialize, and must be closed with a call to apr_terminate at the end of program execution. </dd></dl>
</div>
</div>
<a id="ga4a91a6b9ff457ead13e670950127761a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4a91a6b9ff457ead13e670950127761a">◆ </a></span>apr_initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_initialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Setup any APR internal data structures. This MUST be the first function called for any APR library. It is safe to call apr_initialize several times as long as apr_terminate is called the same number of times. </p><dl class="section remark"><dt>Remarks</dt><dd>See apr_app_initialize if this is an application, rather than a library consumer of apr. </dd></dl>
</div>
</div>
<a id="ga8e96d45ee09fc7e7eb3646efef1424a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8e96d45ee09fc7e7eb3646efef1424a3">◆ </a></span>apr_terminate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_terminate </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tear down any APR internal data structures which aren't torn down automatically. apr_terminate must be called once for every call to <a class="el" href="group__apr__library.html#ga4a91a6b9ff457ead13e670950127761a">apr_initialize()</a> or <a class="el" href="group__apr__library.html#gaa1c4fc2e1c814cc5d4cd3d8719288fc9">apr_app_initialize()</a>. </p><dl class="section remark"><dt>Remarks</dt><dd>An APR program must call this function at termination once it has stopped using APR services. The APR developers suggest using atexit to ensure this is called. When using APR from a language other than C that has problems with the calling convention, use <a class="el" href="group__apr__library.html#ga18667a60ff34d6209e519b4a4ce8cad1">apr_terminate2()</a> instead. </dd></dl>
</div>
</div>
<a id="ga18667a60ff34d6209e519b4a4ce8cad1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga18667a60ff34d6209e519b4a4ce8cad1">◆ </a></span>apr_terminate2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_terminate2 </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tear down any APR internal data structures which aren't torn down automatically, same as apr_terminate </p><dl class="section remark"><dt>Remarks</dt><dd>An APR program must call either the apr_terminate or apr_terminate2 function once it it has finished using APR services. The APR developers suggest using atexit(apr_terminate) to ensure this is done. apr_terminate2 exists to allow non-c language apps to tear down apr, while apr_terminate is recommended from c language applications. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
