GetOpt constants

List of predefined constants for the getopt API.

Syntax

PUBLIC CONSTANT NONE      = 1
PUBLIC CONSTANT REQUIRED  = 2
PUBLIC CONSTANT OPTIONAL  = 3

PUBLIC CONSTANT SUCCESS       = 0
PUBLIC CONSTANT EOF           = 1
PUBLIC CONSTANT BAD_ARGUMENT  = 2

Constant values are provided in this syntax diagram for information. You should obviously use the constant names instead of the values.

Usage

The GetOpt predefined constants are used to implement command line option processing with the getopt module.

The getopt.NONE, getopt.REQUIRED, getopt.OPTIONAL constants are used to define the opt_arg member of elements of the GetoptOptions array used to define the command line options.

The getopt.SUCCESS, getopt.EOF, getopt.BAD_ARGUMENT are return codes of the getopt() method.