trAvis - MANAGER
Edit File: structapr__getopt__t.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_getopt_t Struct Reference</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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li> <li><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="annotated.html"><span>Data Structures</span></a></li> <li><a href="classes.html"><span>Data Structure Index</span></a></li> <li><a href="functions.html"><span>Data Fields</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><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-attribs">Data Fields</a> </div> <div class="headertitle"> <div class="title">apr_getopt_t Struct Reference<div class="ingroups"><a class="el" href="group__apr__getopt.html">Command Argument Parsing</a></div></div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="apr__getopt_8h_source.html">apr_getopt.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Data Fields</h2></td></tr> <tr class="memitem:a63a073fb9c11bb2713b3d7f967e95a24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#a63a073fb9c11bb2713b3d7f967e95a24">cont</a></td></tr> <tr class="separator:a63a073fb9c11bb2713b3d7f967e95a24"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6bf3fd7ad92d1f0161cd895e1ad50d06"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__getopt.html#gae82318936f08cc3531ce9b0856422f27">apr_getopt_err_fn_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#a6bf3fd7ad92d1f0161cd895e1ad50d06">errfn</a></td></tr> <tr class="separator:a6bf3fd7ad92d1f0161cd895e1ad50d06"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a46db55c58789ab7fa99bb49544b0776e"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#a46db55c58789ab7fa99bb49544b0776e">errarg</a></td></tr> <tr class="separator:a46db55c58789ab7fa99bb49544b0776e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab04d49d670f095c3244dc9792b70ff07"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#ab04d49d670f095c3244dc9792b70ff07">ind</a></td></tr> <tr class="separator:ab04d49d670f095c3244dc9792b70ff07"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4f842391b8f8f19e562584fdd29d0654"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#a4f842391b8f8f19e562584fdd29d0654">opt</a></td></tr> <tr class="separator:a4f842391b8f8f19e562584fdd29d0654"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abc4e72bc761666c0b0d9015c3b0de8c3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#abc4e72bc761666c0b0d9015c3b0de8c3">reset</a></td></tr> <tr class="separator:abc4e72bc761666c0b0d9015c3b0de8c3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a58aeb33137aabdd5a00efbde05652094"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#a58aeb33137aabdd5a00efbde05652094">argc</a></td></tr> <tr class="separator:a58aeb33137aabdd5a00efbde05652094"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a296c27d8db2fe6d4b88c5c7a85c40c02"><td class="memItemLeft" align="right" valign="top">const char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#a296c27d8db2fe6d4b88c5c7a85c40c02">argv</a></td></tr> <tr class="separator:a296c27d8db2fe6d4b88c5c7a85c40c02"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a87961387d1c71bebfbdf69c7f392d2d5"><td class="memItemLeft" align="right" valign="top">char const * </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#a87961387d1c71bebfbdf69c7f392d2d5">place</a></td></tr> <tr class="separator:a87961387d1c71bebfbdf69c7f392d2d5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a771dbef87345c731845dd63723fb34db"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#a771dbef87345c731845dd63723fb34db">interleave</a></td></tr> <tr class="separator:a771dbef87345c731845dd63723fb34db"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0cd41eedf9ed82bf5d9dcc3491ee67dd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#a0cd41eedf9ed82bf5d9dcc3491ee67dd">skip_start</a></td></tr> <tr class="separator:a0cd41eedf9ed82bf5d9dcc3491ee67dd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae9e7e6eb1576820c7dc6e589cc3a28b7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#ae9e7e6eb1576820c7dc6e589cc3a28b7">skip_end</a></td></tr> <tr class="separator:ae9e7e6eb1576820c7dc6e589cc3a28b7"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Structure to store command line argument information. </p> </div><h2 class="groupheader">Field Documentation</h2> <a class="anchor" id="a58aeb33137aabdd5a00efbde05652094"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int apr_getopt_t::argc</td> </tr> </table> </div><div class="memdoc"> <p>count of arguments </p> </div> </div> <a class="anchor" id="a296c27d8db2fe6d4b88c5c7a85c40c02"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char** apr_getopt_t::argv</td> </tr> </table> </div><div class="memdoc"> <p>array of pointers to arguments </p> </div> </div> <a class="anchor" id="a63a073fb9c11bb2713b3d7f967e95a24"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a>* apr_getopt_t::cont</td> </tr> </table> </div><div class="memdoc"> <p>context for processing </p> </div> </div> <a class="anchor" id="a46db55c58789ab7fa99bb49544b0776e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void* apr_getopt_t::errarg</td> </tr> </table> </div><div class="memdoc"> <p>user defined first arg to pass to error message </p> </div> </div> <a class="anchor" id="a6bf3fd7ad92d1f0161cd895e1ad50d06"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__getopt.html#gae82318936f08cc3531ce9b0856422f27">apr_getopt_err_fn_t</a>* apr_getopt_t::errfn</td> </tr> </table> </div><div class="memdoc"> <p>function to print error message (NULL == no messages) </p> </div> </div> <a class="anchor" id="ab04d49d670f095c3244dc9792b70ff07"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int apr_getopt_t::ind</td> </tr> </table> </div><div class="memdoc"> <p>index into parent argv vector </p> </div> </div> <a class="anchor" id="a771dbef87345c731845dd63723fb34db"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int apr_getopt_t::interleave</td> </tr> </table> </div><div class="memdoc"> <p>set to nonzero to support interleaving options with regular args </p> </div> </div> <a class="anchor" id="a4f842391b8f8f19e562584fdd29d0654"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int apr_getopt_t::opt</td> </tr> </table> </div><div class="memdoc"> <p>character checked for validity </p> </div> </div> <a class="anchor" id="a87961387d1c71bebfbdf69c7f392d2d5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char const* apr_getopt_t::place</td> </tr> </table> </div><div class="memdoc"> <p>argument associated with option </p> </div> </div> <a class="anchor" id="abc4e72bc761666c0b0d9015c3b0de8c3"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int apr_getopt_t::reset</td> </tr> </table> </div><div class="memdoc"> <p>reset getopt </p> </div> </div> <a class="anchor" id="ae9e7e6eb1576820c7dc6e589cc3a28b7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int apr_getopt_t::skip_end</td> </tr> </table> </div><div class="memdoc"> <p>end of non-option arguments skipped for interleaving </p> </div> </div> <a class="anchor" id="a0cd41eedf9ed82bf5d9dcc3491ee67dd"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int apr_getopt_t::skip_start</td> </tr> </table> </div><div class="memdoc"> <p>start of non-option arguments skipped for interleaving </p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="apr__getopt_8h_source.html">apr_getopt.h</a></li> </ul> </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>