GetOpt Class

GetOpt Members

Public Instance Constructors

GetOpt Constructor Constructor for the GetOpt class. Pass it the programs args list.

Public Instance Properties

Args Returns an ArrayList of supplied arguments (not options). If no arguments are supplied (ie none option args) then this will be empty.

Public Instance Methods

Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetOptionArg Returns the supplied options argument. Throws an exception if option does not have one.
GetType (inherited from Object)Gets the Type of the current instance.
HasArgument Returns true/false based on whether the given option has an argument or not.
IsDefined Returns true/false as to whether an option has been supplied.
Parse Initiates the parsing of the options/arguments supplied to the program.
SetOpts Defines the options you require for your program. You should pass if the options as a string array. There are two modifiers you can use to specify option arguments. Use "=" at the end of your option to specify that this option has to have an argument, and use =? at the end of your option to specify that an argument is optional.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

GetOpt Class | Heyes Namespace