<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: csutil/getopt.h File Reference (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <h1>csutil/getopt.h File Reference</h1>Declarations for getopt. <a href="#_details">More...</a> <p> <code>#include "csextern.h"</code><br> <p> <a href="getopt_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Classes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structgetopt__option.html">getopt_option</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Describe the long-named options requested by the application. <a href="structgetopt__option.html#_details">More...</a><br></td></tr> <tr><td colspan="2"><br><h2>Defines</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8bdd19cad331a646ae8375be00e34cb3"></a><!-- doxytag: member="getopt.h::__STDC__" ref="8bdd19cad331a646ae8375be00e34cb3" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="getopt_8h.html#8bdd19cad331a646ae8375be00e34cb3">__STDC__</a> 1</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3bc1d5f667b5b4ca4b4abb685dc874ce"></a><!-- doxytag: member="getopt.h::no_argument" ref="3bc1d5f667b5b4ca4b4abb685dc874ce" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="getopt_8h.html#3bc1d5f667b5b4ca4b4abb685dc874ce">no_argument</a> 0</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="getopt_8h.html#df33c342f1f93d3574188740b6d00a59">option</a> <a class="el" href="structgetopt__option.html">getopt_option</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Quirk: so that using the word 'option' in any doxygen comments doesn't create a link to <a class="el" href="getopt_8h.html" title="Declarations for getopt.">getopt.h</a>. <a href="#df33c342f1f93d3574188740b6d00a59"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cca06c0a947656bd8b395bf1084ffb72"></a><!-- doxytag: member="getopt.h::optional_argument" ref="cca06c0a947656bd8b395bf1084ffb72" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="getopt_8h.html#cca06c0a947656bd8b395bf1084ffb72">optional_argument</a> 2</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6ece8d8dfa8378778f7290fdaba5b8bc"></a><!-- doxytag: member="getopt.h::required_argument" ref="6ece8d8dfa8378778f7290fdaba5b8bc" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="getopt_8h.html#6ece8d8dfa8378778f7290fdaba5b8bc">required_argument</a> 1</td></tr> <tr><td colspan="2"><br><h2>Variables</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="getopt_8h.html#db50a0eab9fed92fc3bfc7dfa4f2c410">optarg</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">For communication from `getopt' to the caller. <a href="#db50a0eab9fed92fc3bfc7dfa4f2c410"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="getopt_8h.html#e30f05ee1e2e5652f174a35c7875d25e">opterr</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Callers store zero here to inhibit the error message `getopt' prints for unrecognized options. <a href="#e30f05ee1e2e5652f174a35c7875d25e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="getopt_8h.html#d5e1c16213bbee2d5e8cc363309f418c">optind</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Index in ARGV of the next element to be scanned. <a href="#d5e1c16213bbee2d5e8cc363309f418c"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="getopt_8h.html#475b8db98445da73e5f62a1ef6324b95">optopt</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set to an option character which was unrecognized. <a href="#475b8db98445da73e5f62a1ef6324b95"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Declarations for getopt. <p> <p>Definition in file <a class="el" href="getopt_8h-source.html">getopt.h</a>.</p> <hr><h2>Define Documentation</h2> <a class="anchor" name="df33c342f1f93d3574188740b6d00a59"></a><!-- doxytag: member="getopt.h::option" ref="df33c342f1f93d3574188740b6d00a59" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define option <a class="el" href="structgetopt__option.html">getopt_option</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Quirk: so that using the word 'option' in any doxygen comments doesn't create a link to <a class="el" href="getopt_8h.html" title="Declarations for getopt.">getopt.h</a>. <p> <p>Definition at line <a class="el" href="getopt_8h-source.html#l00113">113</a> of file <a class="el" href="getopt_8h-source.html">getopt.h</a>.</p> </div> </div><p> <hr><h2>Variable Documentation</h2> <a class="anchor" name="db50a0eab9fed92fc3bfc7dfa4f2c410"></a><!-- doxytag: member="getopt.h::optarg" ref="db50a0eab9fed92fc3bfc7dfa4f2c410" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char* <a class="el" href="getopt_8h.html#db50a0eab9fed92fc3bfc7dfa4f2c410">optarg</a> </td> </tr> </table> </div> <div class="memdoc"> <p> For communication from `getopt' to the caller. <p> When `getopt' finds an option that takes an argument, the argument value is returned here. Also, when `ordering' is RETURN_IN_ORDER, each non-option ARGV-element is returned here. </div> </div><p> <a class="anchor" name="e30f05ee1e2e5652f174a35c7875d25e"></a><!-- doxytag: member="getopt.h::opterr" ref="e30f05ee1e2e5652f174a35c7875d25e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="getopt_8h.html#e30f05ee1e2e5652f174a35c7875d25e">opterr</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Callers store zero here to inhibit the error message `getopt' prints for unrecognized options. <p> </div> </div><p> <a class="anchor" name="d5e1c16213bbee2d5e8cc363309f418c"></a><!-- doxytag: member="getopt.h::optind" ref="d5e1c16213bbee2d5e8cc363309f418c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="getopt_8h.html#d5e1c16213bbee2d5e8cc363309f418c">optind</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Index in ARGV of the next element to be scanned. <p> This is used for communication to and from the caller and for communication between successive calls to `getopt'.<p> On entry to `getopt', zero means this is the first call; initialize.<p> When `getopt' returns -1, this is the index of the first of the non-option elements that the caller should itself scan.<p> Otherwise, `optind' communicates from one call to the next how much of ARGV has been scanned so far. </div> </div><p> <a class="anchor" name="475b8db98445da73e5f62a1ef6324b95"></a><!-- doxytag: member="getopt.h::optopt" ref="475b8db98445da73e5f62a1ef6324b95" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="getopt_8h.html#475b8db98445da73e5f62a1ef6324b95">optopt</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Set to an option character which was unrecognized. <p> </div> </div><p> <hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>