OptionContext.parse

Parses the command line arguments, recognizing options which have been added to @context. A side-effect of calling this function is that g_set_prgname() will be called.

If the parsing is successful, any parsed arguments are removed from the array and @argc and @argv are updated accordingly. A '--' option is stripped from @argv unless there are unparsed options before and after it, or some of the options after it start with '-'. In case of an error, @argc and @argv are left unmodified.

If automatic --help support is enabled (see g_option_context_set_help_enabled()), and the @argv array contains one of the recognized help options, this function will produce help output to stdout and call exit (0).

Note that function depends on the [current locale]setlocale for automatic character set conversion of string and filename arguments.

class OptionContext
bool
parse
(
ref string[] argv
)

Parameters

argv string[]

a pointer to the array of command line arguments

Return Value

Type: bool

%TRUE if the parsing was successful, %FALSE if an error occurred

Throws

GException on failure.

Meta