trAvis - MANAGER
Edit File: apr__env_8h_source.html
<!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.5"/> <title>Apache Portable Runtime: apr_env.h Source File</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/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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 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.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <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 id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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 id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">apr_env.h</div> </div> </div><!--header--> <div class="contents"> <a href="apr__env_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * this work for additional information regarding copyright ownership.</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * (the "License"); you may not use this file except in compliance with</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * limitations under the License.</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef APR_ENV_H</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define APR_ENV_H</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span><span class="comment">/**</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * @file apr_env.h</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * @brief APR Environment functions</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> */</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html">apr_errno.h</a>"</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html">apr_pools.h</a>"</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span><span class="comment"></span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/**</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * @defgroup apr_env Functions for manipulating the environment</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * @ingroup APR </span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * @{</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> */</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/**</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * Get the value of an environment variable</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * @param value the returned value, allocated from @a pool</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * @param envvar the name of the environment variable</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @param pool where to allocate @a value and any temporary storage from</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> */</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__env.html#gada7cd6ccada789a3738f8fc6334da809">apr_env_get</a>(<span class="keywordtype">char</span> **value, const <span class="keywordtype">char</span> *envvar,</div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);</div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/**</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * Set the value of an environment variable</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * @param envvar the name of the environment variable</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * @param value the value to set</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @param pool where to allocate temporary storage from</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> */</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__env.html#gae11f733a639393a35e82c795f4ecd470">apr_env_set</a>(const <span class="keywordtype">char</span> *envvar, const <span class="keywordtype">char</span> *value,</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);</div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">/**</span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * Delete a variable from the environment</span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * @param envvar the name of the environment variable</span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * @param pool where to allocate temporary storage from</span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> */</span></div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <a class="code" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group__apr__env.html#ga2bfac0686199b2fee97a7638df7cbfdc">apr_env_delete</a>(const <span class="keywordtype">char</span> *envvar, <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);</div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">/** @} */</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"></span>}</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#endif </span><span class="comment">/* ! APR_ENV_H */</span><span class="preprocessor"></span></div> <div class="ttc" id="group__apr__platform_html_gad7b91b811a172bfa802603c2fb688f98"><div class="ttname"><a href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a></div><div class="ttdeci">#define APR_DECLARE(type)</div><div class="ttdef"><b>Definition:</b> apr.h:480</div></div> <div class="ttc" id="apr__pools_8h_html"><div class="ttname"><a href="apr__pools_8h.html">apr_pools.h</a></div><div class="ttdoc">APR memory allocation. </div></div> <div class="ttc" id="apr__errno_8h_html"><div class="ttname"><a href="apr__errno_8h.html">apr_errno.h</a></div><div class="ttdoc">APR Error Codes. </div></div> <div class="ttc" id="group__apr__env_html_gae11f733a639393a35e82c795f4ecd470"><div class="ttname"><a href="group__apr__env.html#gae11f733a639393a35e82c795f4ecd470">apr_env_set</a></div><div class="ttdeci">apr_status_t apr_env_set(const char *envvar, const char *value, apr_pool_t *pool)</div></div> <div class="ttc" id="group__apr__env_html_gada7cd6ccada789a3738f8fc6334da809"><div class="ttname"><a href="group__apr__env.html#gada7cd6ccada789a3738f8fc6334da809">apr_env_get</a></div><div class="ttdeci">apr_status_t apr_env_get(char **value, const char *envvar, apr_pool_t *pool)</div></div> <div class="ttc" id="group__apr__pools_html_gaf137f28edcf9a086cd6bc36c20d7cdfb"><div class="ttname"><a href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a></div><div class="ttdeci">struct apr_pool_t apr_pool_t</div><div class="ttdef"><b>Definition:</b> apr_pools.h:60</div></div> <div class="ttc" id="group__apr__errno_html_gaf76ee4543247e9fb3f3546203e590a6c"><div class="ttname"><a href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a></div><div class="ttdeci">int apr_status_t</div><div class="ttdef"><b>Definition:</b> apr_errno.h:44</div></div> <div class="ttc" id="group__apr__env_html_ga2bfac0686199b2fee97a7638df7cbfdc"><div class="ttname"><a href="group__apr__env.html#ga2bfac0686199b2fee97a7638df7cbfdc">apr_env_delete</a></div><div class="ttdeci">apr_status_t apr_env_delete(const char *envvar, apr_pool_t *pool)</div></div> </div><!-- fragment --></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.5 </small></address> </body> </html>