<!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: apr_getopt.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/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>
<!-- 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 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_getopt.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="apr__getopt_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_GETOPT_H</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define APR_GETOPT_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/**</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * @file apr_getopt.h</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * @brief APR Command Arguments (getopt)</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html">apr_pools.h</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span><span class="preprocessor"></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">/**</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * @defgroup apr_getopt Command Argument Parsing</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * @ingroup APR </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">/** </span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * An @c apr_getopt_t error callback function.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> *</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @a arg is this @c apr_getopt_t's @c errarg member.</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"><a class="line" href="group__apr__getopt.html#gad0f6c9baec81bc84293e0f1e2262656e"> 42</a></span> <span class="keyword">typedef</span> void (<a class="code" href="group__apr__getopt.html#gad0f6c9baec81bc84293e0f1e2262656e">apr_getopt_err_fn_t</a>)(<span class="keywordtype">void</span> *arg, <span class="keyword">const</span> <span class="keywordtype">char</span> *err, ...);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">/** @see apr_getopt_t */</span></div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="group__apr__getopt.html#gaed49565eab64803e93f76d0c40d6873d"> 45</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structapr__getopt__t.html">apr_getopt_t</a> <a class="code" href="structapr__getopt__t.html">apr_getopt_t</a>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">/**</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * Structure to store command line argument information.</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> */</span> </div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structapr__getopt__t.html"> 50</a></span> <span class="keyword">struct </span><a class="code" href="structapr__getopt__t.html">apr_getopt_t</a> {<span class="comment"></span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> /** context for processing */</span></div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structapr__getopt__t.html#a63a073fb9c11bb2713b3d7f967e95a24"> 52</a></span>  <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *<a class="code" href="structapr__getopt__t.html#a63a073fb9c11bb2713b3d7f967e95a24">cont</a>;<span class="comment"></span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> /** function to print error message (NULL == no messages) */</span></div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structapr__getopt__t.html#a6bf3fd7ad92d1f0161cd895e1ad50d06"> 54</a></span>  <a class="code" href="group__apr__getopt.html#gad0f6c9baec81bc84293e0f1e2262656e">apr_getopt_err_fn_t</a> *<a class="code" href="structapr__getopt__t.html#a6bf3fd7ad92d1f0161cd895e1ad50d06">errfn</a>;<span class="comment"></span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /** user defined first arg to pass to error message */</span></div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structapr__getopt__t.html#a46db55c58789ab7fa99bb49544b0776e"> 56</a></span>  <span class="keywordtype">void</span> *<a class="code" href="structapr__getopt__t.html#a46db55c58789ab7fa99bb49544b0776e">errarg</a>;<span class="comment"></span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> /** index into parent argv vector */</span></div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structapr__getopt__t.html#ab04d49d670f095c3244dc9792b70ff07"> 58</a></span>  <span class="keywordtype">int</span> <a class="code" href="structapr__getopt__t.html#ab04d49d670f095c3244dc9792b70ff07">ind</a>;<span class="comment"></span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> /** character checked for validity */</span></div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structapr__getopt__t.html#a4f842391b8f8f19e562584fdd29d0654"> 60</a></span>  <span class="keywordtype">int</span> <a class="code" href="structapr__getopt__t.html#a4f842391b8f8f19e562584fdd29d0654">opt</a>;<span class="comment"></span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> /** reset getopt */</span></div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structapr__getopt__t.html#abc4e72bc761666c0b0d9015c3b0de8c3"> 62</a></span>  <span class="keywordtype">int</span> <a class="code" href="structapr__getopt__t.html#abc4e72bc761666c0b0d9015c3b0de8c3">reset</a>;<span class="comment"></span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> /** count of arguments */</span></div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structapr__getopt__t.html#a58aeb33137aabdd5a00efbde05652094"> 64</a></span>  <span class="keywordtype">int</span> <a class="code" href="structapr__getopt__t.html#a58aeb33137aabdd5a00efbde05652094">argc</a>;<span class="comment"></span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> /** array of pointers to arguments */</span></div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="structapr__getopt__t.html#a296c27d8db2fe6d4b88c5c7a85c40c02"> 66</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> **<a class="code" href="structapr__getopt__t.html#a296c27d8db2fe6d4b88c5c7a85c40c02">argv</a>;<span class="comment"></span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> /** argument associated with option */</span></div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="structapr__getopt__t.html#a87961387d1c71bebfbdf69c7f392d2d5"> 68</a></span>  <span class="keywordtype">char</span> <span class="keyword">const</span>* <a class="code" href="structapr__getopt__t.html#a87961387d1c71bebfbdf69c7f392d2d5">place</a>;<span class="comment"></span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> /** set to nonzero to support interleaving options with regular args */</span></div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="structapr__getopt__t.html#a771dbef87345c731845dd63723fb34db"> 70</a></span>  <span class="keywordtype">int</span> <a class="code" href="structapr__getopt__t.html#a771dbef87345c731845dd63723fb34db">interleave</a>;<span class="comment"></span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> /** start of non-option arguments skipped for interleaving */</span></div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="structapr__getopt__t.html#a0cd41eedf9ed82bf5d9dcc3491ee67dd"> 72</a></span>  <span class="keywordtype">int</span> <a class="code" href="structapr__getopt__t.html#a0cd41eedf9ed82bf5d9dcc3491ee67dd">skip_start</a>;<span class="comment"></span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> /** end of non-option arguments skipped for interleaving */</span></div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="structapr__getopt__t.html#ae9e7e6eb1576820c7dc6e589cc3a28b7"> 74</a></span>  <span class="keywordtype">int</span> <a class="code" href="structapr__getopt__t.html#ae9e7e6eb1576820c7dc6e589cc3a28b7">skip_end</a>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> };</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">/** @see apr_getopt_option_t */</span></div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="group__apr__getopt.html#ga114d2af52f3573eaeee2ffa73b2c4ff5"> 78</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structapr__getopt__option__t.html">apr_getopt_option_t</a> <a class="code" href="structapr__getopt__option__t.html">apr_getopt_option_t</a>;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">/**</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * Structure used to describe options that getopt should search for.</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> */</span></div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="structapr__getopt__option__t.html"> 83</a></span> <span class="keyword">struct </span><a class="code" href="structapr__getopt__option__t.html">apr_getopt_option_t</a> {<span class="comment"></span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> /** long option name, or NULL if option has no long name */</span></div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="structapr__getopt__option__t.html#a7e623913c9761495c5d37adf6ff1ee69"> 85</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structapr__getopt__option__t.html#a7e623913c9761495c5d37adf6ff1ee69">name</a>;<span class="comment"></span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> /** option letter, or a value greater than 255 if option has no letter */</span></div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="structapr__getopt__option__t.html#a476e67c4dde620fe5b4f5952238c6e94"> 87</a></span>  <span class="keywordtype">int</span> <a class="code" href="structapr__getopt__option__t.html#a476e67c4dde620fe5b4f5952238c6e94">optch</a>;<span class="comment"></span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> /** nonzero if option takes an argument */</span></div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="structapr__getopt__option__t.html#aac65dae93f6d35f4848b91f6f9d66278"> 89</a></span>  <span class="keywordtype">int</span> <a class="code" href="structapr__getopt__option__t.html#aac65dae93f6d35f4848b91f6f9d66278">has_arg</a>;<span class="comment"></span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> /** a description of the option */</span></div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="structapr__getopt__option__t.html#a8fd515c0a9e621f6c0d058772429ab98"> 91</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structapr__getopt__option__t.html#a8fd515c0a9e621f6c0d058772429ab98">description</a>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> };</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"></span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">/**</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * Initialize the arguments for parsing by apr_getopt().</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * @param os The options structure created for apr_getopt()</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * @param cont The pool to operate on</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * @param argc The number of arguments to parse</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * @param argv The array of arguments to parse</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * @remark Arguments 3 and 4 are most commonly argc and argv from main(argc, argv)</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * The (*os)->errfn is initialized to fprintf(stderr... but may be overridden.</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> */</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</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__getopt.html#gaaab2b4bfb62361af7a2d427f5f29a3d4">apr_getopt_init</a>(<a class="code" href="structapr__getopt__t.html">apr_getopt_t</a> **os, <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *<a class="code" href="structapr__getopt__t.html#a63a073fb9c11bb2713b3d7f967e95a24">cont</a>,</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">int</span> <a class="code" href="structapr__getopt__t.html#a58aeb33137aabdd5a00efbde05652094">argc</a>, <span class="keyword">const</span> <span class="keywordtype">char</span> * <span class="keyword">const</span> *<a class="code" href="structapr__getopt__t.html#a296c27d8db2fe6d4b88c5c7a85c40c02">argv</a>);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"></span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">/**</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * Parse the options initialized by apr_getopt_init().</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * @param os The apr_opt_t structure returned by apr_getopt_init()</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * @param opts A string of characters that are acceptable options to the </span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * program. Characters followed by ":" are required to have an </span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * option associated</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * @param option_ch The next option character parsed</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * @param option_arg The argument following the option character:</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * @return There are four potential status values on exit. They are:</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * <PRE></span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * APR_EOF -- No more options to parse</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * APR_BADCH -- Found a bad option character</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * APR_BADARG -- No argument followed the option flag</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * APR_SUCCESS -- The next option was found.</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * </PRE></span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> */</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</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__getopt.html#ga289cdcf7eacc997eb91fea7c02d08934">apr_getopt</a>(<a class="code" href="structapr__getopt__t.html">apr_getopt_t</a> *os, <span class="keyword">const</span> <span class="keywordtype">char</span> *opts, </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">char</span> *option_ch, <span class="keyword">const</span> <span class="keywordtype">char</span> **option_arg);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"></span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment">/**</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * Parse the options initialized by apr_getopt_init(), accepting long</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * options beginning with "--" in addition to single-character</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * options beginning with "-".</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * @param os The apr_getopt_t structure created by apr_getopt_init()</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * @param opts A pointer to a list of apr_getopt_option_t structures, which</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * can be initialized with { "name", optch, has_args }. has_args</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * is nonzero if the option requires an argument. A structure</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * with an optch value of 0 terminates the list.</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * @param option_ch Receives the value of "optch" from the apr_getopt_option_t</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * structure corresponding to the next option matched.</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * @param option_arg Receives the argument following the option, if any.</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * @return There are four potential status values on exit. They are:</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * <PRE></span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * APR_EOF -- No more options to parse</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * APR_BADCH -- Found a bad option character</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * APR_BADARG -- No argument followed the option flag</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * APR_SUCCESS -- The next option was found.</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * </PRE></span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * When APR_SUCCESS is returned, os->ind gives the index of the first</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * non-option argument. On error, a message will be printed to stdout unless</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * os->err is set to 0. If os->interleave is set to nonzero, options can come</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * after arguments, and os->argv will be permuted to leave non-option arguments</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * at the end (the original argv is unaffected).</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> */</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</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__getopt.html#ga80d6ff2213da4e25406b3f179fa13989">apr_getopt_long</a>(<a class="code" href="structapr__getopt__t.html">apr_getopt_t</a> *os,</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keyword">const</span> <a class="code" href="structapr__getopt__option__t.html">apr_getopt_option_t</a> *opts,</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordtype">int</span> *option_ch,</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> **option_arg);<span class="comment"></span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">/** @} */</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> }</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="preprocessor">#endif </span><span class="comment">/* ! APR_GETOPT_H */</span><span class="preprocessor"></span></div><div class="ttc" id="group__apr__getopt_html_ga289cdcf7eacc997eb91fea7c02d08934"><div class="ttname"><a href="group__apr__getopt.html#ga289cdcf7eacc997eb91fea7c02d08934">apr_getopt</a></div><div class="ttdeci">apr_status_t apr_getopt(apr_getopt_t *os, const char *opts, char *option_ch, const char **option_arg)</div></div>
<div class="ttc" id="structapr__getopt__t_html_a58aeb33137aabdd5a00efbde05652094"><div class="ttname"><a href="structapr__getopt__t.html#a58aeb33137aabdd5a00efbde05652094">apr_getopt_t::argc</a></div><div class="ttdeci">int argc</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:64</div></div>
<div class="ttc" id="structapr__getopt__t_html"><div class="ttname"><a href="structapr__getopt__t.html">apr_getopt_t</a></div><div class="ttdef"><b>Definition:</b> apr_getopt.h:50</div></div>
<div class="ttc" id="structapr__getopt__option__t_html_a7e623913c9761495c5d37adf6ff1ee69"><div class="ttname"><a href="structapr__getopt__option__t.html#a7e623913c9761495c5d37adf6ff1ee69">apr_getopt_option_t::name</a></div><div class="ttdeci">const char * name</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:85</div></div>
<div class="ttc" id="structapr__getopt__t_html_abc4e72bc761666c0b0d9015c3b0de8c3"><div class="ttname"><a href="structapr__getopt__t.html#abc4e72bc761666c0b0d9015c3b0de8c3">apr_getopt_t::reset</a></div><div class="ttdeci">int reset</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:62</div></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:479</div></div>
<div class="ttc" id="structapr__getopt__t_html_ab04d49d670f095c3244dc9792b70ff07"><div class="ttname"><a href="structapr__getopt__t.html#ab04d49d670f095c3244dc9792b70ff07">apr_getopt_t::ind</a></div><div class="ttdeci">int ind</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:58</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="structapr__getopt__option__t_html_a8fd515c0a9e621f6c0d058772429ab98"><div class="ttname"><a href="structapr__getopt__option__t.html#a8fd515c0a9e621f6c0d058772429ab98">apr_getopt_option_t::description</a></div><div class="ttdeci">const char * description</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:91</div></div>
<div class="ttc" id="structapr__getopt__t_html_a6bf3fd7ad92d1f0161cd895e1ad50d06"><div class="ttname"><a href="structapr__getopt__t.html#a6bf3fd7ad92d1f0161cd895e1ad50d06">apr_getopt_t::errfn</a></div><div class="ttdeci">apr_getopt_err_fn_t * errfn</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:54</div></div>
<div class="ttc" id="group__apr__getopt_html_gaaab2b4bfb62361af7a2d427f5f29a3d4"><div class="ttname"><a href="group__apr__getopt.html#gaaab2b4bfb62361af7a2d427f5f29a3d4">apr_getopt_init</a></div><div class="ttdeci">apr_status_t apr_getopt_init(apr_getopt_t **os, apr_pool_t *cont, int argc, const char *const *argv)</div></div>
<div class="ttc" id="structapr__getopt__option__t_html_aac65dae93f6d35f4848b91f6f9d66278"><div class="ttname"><a href="structapr__getopt__option__t.html#aac65dae93f6d35f4848b91f6f9d66278">apr_getopt_option_t::has_arg</a></div><div class="ttdeci">int has_arg</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:89</div></div>
<div class="ttc" id="structapr__getopt__t_html_a46db55c58789ab7fa99bb49544b0776e"><div class="ttname"><a href="structapr__getopt__t.html#a46db55c58789ab7fa99bb49544b0776e">apr_getopt_t::errarg</a></div><div class="ttdeci">void * errarg</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:56</div></div>
<div class="ttc" id="structapr__getopt__t_html_a771dbef87345c731845dd63723fb34db"><div class="ttname"><a href="structapr__getopt__t.html#a771dbef87345c731845dd63723fb34db">apr_getopt_t::interleave</a></div><div class="ttdeci">int interleave</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:70</div></div>
<div class="ttc" id="structapr__getopt__option__t_html_a476e67c4dde620fe5b4f5952238c6e94"><div class="ttname"><a href="structapr__getopt__option__t.html#a476e67c4dde620fe5b4f5952238c6e94">apr_getopt_option_t::optch</a></div><div class="ttdeci">int optch</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:87</div></div>
<div class="ttc" id="structapr__getopt__t_html_a87961387d1c71bebfbdf69c7f392d2d5"><div class="ttname"><a href="structapr__getopt__t.html#a87961387d1c71bebfbdf69c7f392d2d5">apr_getopt_t::place</a></div><div class="ttdeci">char const * place</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:68</div></div>
<div class="ttc" id="structapr__getopt__t_html_a0cd41eedf9ed82bf5d9dcc3491ee67dd"><div class="ttname"><a href="structapr__getopt__t.html#a0cd41eedf9ed82bf5d9dcc3491ee67dd">apr_getopt_t::skip_start</a></div><div class="ttdeci">int skip_start</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:72</div></div>
<div class="ttc" id="group__apr__getopt_html_ga80d6ff2213da4e25406b3f179fa13989"><div class="ttname"><a href="group__apr__getopt.html#ga80d6ff2213da4e25406b3f179fa13989">apr_getopt_long</a></div><div class="ttdeci">apr_status_t apr_getopt_long(apr_getopt_t *os, const apr_getopt_option_t *opts, int *option_ch, const char **option_arg)</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__getopt_html_gad0f6c9baec81bc84293e0f1e2262656e"><div class="ttname"><a href="group__apr__getopt.html#gad0f6c9baec81bc84293e0f1e2262656e">apr_getopt_err_fn_t</a></div><div class="ttdeci">void() apr_getopt_err_fn_t(void *arg, const char *err,...)</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:42</div></div>
<div class="ttc" id="structapr__getopt__t_html_a4f842391b8f8f19e562584fdd29d0654"><div class="ttname"><a href="structapr__getopt__t.html#a4f842391b8f8f19e562584fdd29d0654">apr_getopt_t::opt</a></div><div class="ttdeci">int opt</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:60</div></div>
<div class="ttc" id="structapr__getopt__t_html_a296c27d8db2fe6d4b88c5c7a85c40c02"><div class="ttname"><a href="structapr__getopt__t.html#a296c27d8db2fe6d4b88c5c7a85c40c02">apr_getopt_t::argv</a></div><div class="ttdeci">const char ** argv</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:66</div></div>
<div class="ttc" id="structapr__getopt__t_html_a63a073fb9c11bb2713b3d7f967e95a24"><div class="ttname"><a href="structapr__getopt__t.html#a63a073fb9c11bb2713b3d7f967e95a24">apr_getopt_t::cont</a></div><div class="ttdeci">apr_pool_t * cont</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:52</div></div>
<div class="ttc" id="structapr__getopt__t_html_ae9e7e6eb1576820c7dc6e589cc3a28b7"><div class="ttname"><a href="structapr__getopt__t.html#ae9e7e6eb1576820c7dc6e589cc3a28b7">apr_getopt_t::skip_end</a></div><div class="ttdeci">int skip_end</div><div class="ttdef"><b>Definition:</b> apr_getopt.h:74</div></div>
<div class="ttc" id="structapr__getopt__option__t_html"><div class="ttname"><a href="structapr__getopt__option__t.html">apr_getopt_option_t</a></div><div class="ttdef"><b>Definition:</b> apr_getopt.h:83</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.13
</small></address>
</body>
</html>
