<a name="g-option-context-free"></a>g_option_context_free ()</h3><a class="indexterm" name="id3128521"></a><pre class="programlisting">void                g_option_context_free               (<a class="link" href="glib-Commandline-option-parser.html#GOptionContext">GOptionContext</a> *context);</pre><p>Frees context and all the groups which have been added to it.</p><p></p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><p><span class="term"><em class="parameter"><code>context</code></em>&#160;:</span></p></td><td> a <a class="link" href="glib-Commandline-option-parser.html#GOptionContext"><span class="type">GOptionContext</span></a> </td></tr></tbody></table></div><p class="since">Since  2.6</p></div><hr><div class="refsect2" lang="en"><a name="id3128586"></a><h3><a name="g-option-context-parse"></a>g_option_context_parse ()</h3><a class="indexterm" name="id3128602"></a><pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gboolean">gboolean</a>            g_option_context_parse              (<a class="link" href="glib-Commandline-option-parser.html#GOptionContext">GOptionContext</a> *context,                                                         <a class="link" href="glib-Basic-Types.html#gint">gint</a> *argc,                                                         <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> ***argv,                                                         <a class="link" href="glib-Error-Reporting.html#GError">GError</a> **error);</pre><p>Parses the command line arguments, recognizing optionswhich have been added to <em class="parameter"><code>context</code></em>. A side-effect of calling this function is that <a class="link" href="glib-Miscellaneous-Utility-Functions.html#g-set-prgname"><code class="function">g_set_prgname()</code></a> will becalled.</p><p>If the parsing is successful, any parsed arguments areremoved from the array and <em class="parameter"><code>argc</code></em> and <em class="parameter"><code>argv</code></em> are updated accordingly. A '--' option is stripped from <em class="parameter"><code>argv</code></em>unless there are unparsed options before and after it, or some of the options after it start with '-'. In case of an error, <em class="parameter"><code>argc</code></em> and <em class="parameter"><code>argv</code></em> are left unmodified. </p><p>If automatic <code class="option">--help</code> support is enabled(see <a class="link" href="glib-Commandline-option-parser.html#g-option-context-set-help-enabled"><code class="function">g_option_context_set_help_enabled()</code></a>), and the <em class="parameter"><code>argv</code></em> array contains one of the recognized help options,this function will produce help output to stdout andcall <code class="literal">exit (0)</code>.</p><p>Note that function depends on the <a class="link" href="glib-running.html#setlocale" title="Locale">current locale</a> for automatic character set conversion of string and filenamearguments.</p><p></p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><p><span class="term"><em class="parameter"><code>context</code></em>&#160;:</span></p></td><td> a <a class="link" href="glib-Commandline-option-parser.html#GOptionContext"><span class="type">GOptionContext</span></a></td></tr><tr><td><p><span class="term"><em class="parameter"><code>argc</code></em>&#160;:</span></p></td><td> a pointer to the number of command line arguments</td></tr><tr><td><p><span class="term"><em class="parameter"><code>argv</code></em>&#160;:</span></p></td><td> a pointer to the array of command line arguments</td></tr><tr><td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td><td> a return location for errors </td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td><td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the parsing was successful,               <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if an error occurred</td></tr></tbody></table></div><p class="since">Since  2.6</p></div><hr><div class="refsect2" lang="en"><a name="id3128866"></a><h3><a name="g-option-context-set-help-enabled"></a>g_option_context_set_help_enabled ()</h3><a class="indexterm" name="id3128883"></a><pre class="programlisting">void                g_option_context_set_help_enabled   (<a class="link" href="glib-Commandline-option-parser.html#GOptionContext">GOptionContext</a> *context,                                                         <a class="link" href="glib-Basic-Types.html#gboolean">gboolean</a> help_enabled);</pre><p>Enables or disables automatic generation of <code class="option">--help</code> output. By default, <a class="link" href="glib-Commandline-option-parser.html#g-option-context-parse"><code class="function">g_option_context_parse()</code></a> recognizes<code class="option">--help</code>, <code class="option">-?</code>, <code class="option">--help-all</code>and <code class="option">--help-</code><em class="replaceable"><code>groupname</code></em> and createssuitable output to stdout.</p><p></p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><p><span class="term"><em class="parameter"><code>context</code></em>&#160;:</span></p></td><td> a <a class="link" href="glib-Commandline-option-parser.html#GOptionContext"><span class="type">GOptionContext</span></a></td></tr><tr><td><p><span class="term"><em class="parameter"><code>help_enabled</code></em>&#160;:</span></p></td><td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to enable <code class="option">--help</code>, <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to disable it</td></tr></tbody></table></div><p class="since">Since  2.6</p></div><hr><div class="refsect2" lang="en"><a name="id3129026"></a><h3><a name="g-option-context-get-help-enabled"></a>g_option_context_get_help_enabled ()</h3><a class="indexterm" name="id3129043"></a><pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gboolean">gboolean</a>            g_option_context_get_help_enabled   (<a class="link" href="glib-Commandline-option-parser.html#GOptionContext">GOptionContext</a> *context);</pre><p>Returns whether automatic <code class="option">--help</code> generationis turned on for <em class="parameter"><code>context</code></em>. See <a class="link" href="glib-Commandline-option-parser.html#g-option-context-set-help-enabled"><code class="function">g_option_context_set_help_enabled()</code></a>.</p><p></p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><p><span class="term"><em class="parameter"><code>context</code></em>&#160;:</span></p></td><td> a <a class="link" href="glib-Commandline-option-parser.html#GOptionContext"><span class="type">GOptionContext</span></a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td><td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if automatic help generation is turned on.</td></tr></tbody></table></div><p class="since">Since  2.6</p></div><hr><div class="refsect2" lang="en"><a name="id3129150"></a><h3><a name="g-option-context-set-ignore-unknown-options"></a>g_option_context_set_ignore_unknown_options ()</h3><a class="indexterm" name="id3129167"></a><pre class="programlisting">void                g_option_context_set_ignore_unknown_options                                                        (<a class="link" href="glib-Commandline-option-parser.html#GOptionContext">GOptionContext</a> *context,                                                         <a class="link" href="glib-Basic-Types.html#gboolean">gboolean</a> ignore_unknown);</pre><p>Sets whether to ignore unknown options or not. If an argument is ignored, it is left in the <em class="parameter"><code>argv</code></em> array after parsing. By default, <a class="link" href="glib-Commandline-option-parser.html#g-option-context-parse"><code class="function">g_option_context_parse()</code></a> treats unknown options as error.</p><p>This setting does not affect non-option arguments (i.e. arguments which don't start with a dash). But note that GOption cannot reliablydetermine whether a non-option belongs to a preceding unknown option.</p><p></p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><p><span class="term"><em class="parameter"><code>context</code></em>&#160;:</span></p></td><td> a <a class="link" href="glib-Commandline-option-parser.html#GOptionContext"><span class="type">GOptionContext</span></a></td></tr><tr><td><p><span class="term"><em class="parameter"><code>ignore_unknown</code></em>&#160;:</span></p></td><td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to ignore unknown options, <a class="link" href="glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to produce   an error when unknown options are met</td></tr></tbody></table></div><p class="since">Since  2.6</p></div><hr><div class="refsect2" lang="en"><a name="id3129302"></a><h3><a name="g-option-context-get-ignore-unknown-options"></a>g_option_context_get_ignore_unknown_options ()</h3><a class="indexterm" name="id3129319"></a><pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gboolean">gboolean</a>            g_option_context_get_ignore_unknown_options                                                        (<a class="link" href="glib-Commandline-option-parser.html#GOptionContext">GOptionContext</a> *context);</pre><p>Returns whether unknown options are ignored or not. See<a class="link" href="glib-Commandline-option-parser.html#g-option-context-set-ignore-unknown-options"><code class="function">g_option_context_set_ignore_unknown_options()</code></a>.</p><p></p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><p><span class="term"><em class="parameter"><code>context</code></em>&#160;:</span></p></td><td> a <a class="link" href="glib-Commandline-option-parser.html#GOptionContext"><span class="type">GOptionContext</span></a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td><td> <a class="link" href="glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if unknown options are ignored.</td></tr></tbody></table></div><p class="since">Since  2.6</p></div><hr><div class="refsect2" lang="en"><a name="id3129419"></a><h3><a name="g-option-context-get-help"></a>g_option_context_get_help ()</h3>