comp • gb.args • args

Args (gb.args)

This class analyses the arguments of the current process.

It allows you to:

  • Extract options from the program arguments.

  • Automatically handle --version and --help options.

  • Return non-options as arguments.

Use the Begin method to start the option analysis and the End method to terminate it.

This class will automatically print help, usage and version messages to the standard output.

If an error occurs, the program quits with the exit code 1.

This class reimplements Args in gb.
This class is static.
This class acts like a
Returns the program argument specified by the Index parameter.
read-only
static array.
This class is
Enumerates all arguments passed to the application.
statically enumerable
with the FOR EACH keyword.

Static properties

Static methods
Return a copy of the process arguments as a string array.
All  
Return the number of command line arguments.
Count  
Returns Args.Count - 1
Max  
Start the program argument analysis.
Begin  
Terminate the program argument analysis, and return all arguments that could not be interpreted as an option or an option argument.
End  
Define an option that takes one string argument, and return it.
Get  
Define an option that takes one floating point number argument, and return it.
GetFloat  
Define an option that takes one integer number argument, and return it.
GetInteger  
Define an option that takes no argument, and return if it has been specified.
Has