<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Apache Portable Runtime: apr_getopt_t Struct Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.3.9.1 --> <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div> <h1>apr_getopt_t Struct Reference<br> <small> [<a class="el" href="group__apr__getopt.html">Command Argument Parsing</a>]</small> </h1><code>#include <<a class="el" href="apr__getopt_8h-source.html">apr_getopt.h</a>></code> <p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#o0">cont</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__getopt.html#ga0">apr_getopt_err_fn_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#o1">errfn</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#o2">errarg</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#o3">ind</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#o4">opt</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#o5">reset</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#o6">argc</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#o7">argv</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">char const * </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#o8">place</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#o9">interleave</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#o10">skip_start</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__getopt__t.html#o11">skip_end</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Structure to store command line argument information. <p> <hr><h2>Field Documentation</h2> <a class="anchor" name="o6" doxytag="apr_getopt_t::argc"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">int <a class="el" href="structapr__getopt__t.html#o6">apr_getopt_t::argc</a> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> count of arguments </td> </tr> </table> <a class="anchor" name="o7" doxytag="apr_getopt_t::argv"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">const char** <a class="el" href="structapr__getopt__t.html#o7">apr_getopt_t::argv</a> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> array of pointers to arguments </td> </tr> </table> <a class="anchor" name="o0" doxytag="apr_getopt_t::cont"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a>* <a class="el" href="structapr__getopt__t.html#o0">apr_getopt_t::cont</a> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> context for processing </td> </tr> </table> <a class="anchor" name="o2" doxytag="apr_getopt_t::errarg"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void* <a class="el" href="structapr__getopt__t.html#o2">apr_getopt_t::errarg</a> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> user defined first arg to pass to error message </td> </tr> </table> <a class="anchor" name="o1" doxytag="apr_getopt_t::errfn"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"><a class="el" href="group__apr__getopt.html#ga0">apr_getopt_err_fn_t</a>* <a class="el" href="structapr__getopt__t.html#o1">apr_getopt_t::errfn</a> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> function to print error message (NULL == no messages) </td> </tr> </table> <a class="anchor" name="o3" doxytag="apr_getopt_t::ind"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">int <a class="el" href="structapr__getopt__t.html#o3">apr_getopt_t::ind</a> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> index into parent argv vector </td> </tr> </table> <a class="anchor" name="o9" doxytag="apr_getopt_t::interleave"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">int <a class="el" href="structapr__getopt__t.html#o9">apr_getopt_t::interleave</a> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> set to nonzero to support interleaving options with regular args </td> </tr> </table> <a class="anchor" name="o4" doxytag="apr_getopt_t::opt"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">int <a class="el" href="structapr__getopt__t.html#o4">apr_getopt_t::opt</a> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> character checked for validity </td> </tr> </table> <a class="anchor" name="o8" doxytag="apr_getopt_t::place"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">char const* <a class="el" href="structapr__getopt__t.html#o8">apr_getopt_t::place</a> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> argument associated with option </td> </tr> </table> <a class="anchor" name="o5" doxytag="apr_getopt_t::reset"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">int <a class="el" href="structapr__getopt__t.html#o5">apr_getopt_t::reset</a> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> reset getopt </td> </tr> </table> <a class="anchor" name="o11" doxytag="apr_getopt_t::skip_end"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">int <a class="el" href="structapr__getopt__t.html#o11">apr_getopt_t::skip_end</a> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> end of non-option arguments skipped for interleaving </td> </tr> </table> <a class="anchor" name="o10" doxytag="apr_getopt_t::skip_start"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">int <a class="el" href="structapr__getopt__t.html#o10">apr_getopt_t::skip_start</a> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> start of non-option arguments skipped for interleaving </td> </tr> </table> <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></ul> <hr size="1"><address style="align: right;"><small>Generated on Sun Mar 20 19:52:26 2005 for Apache Portable Runtime by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address> </body> </html>