getopt.net.ParseException Class Reference

Generic exception class that is thrown when the parser is not configured to ignore errors. More...

Inheritance diagram for getopt.net.ParseException:

Public Member Functions
	ParseException (string msg)
	Generic exception constructor; only accepts the error message. More...
	ParseException (string? optString, string msg)
	Specialsied exception constructor; accepts the option causing the error and an accompanying message. More...
override string	ToString ()

Properties
string?	Option [get, set]
	The option that caused the exception. More...

Detailed Description

Generic exception class that is thrown when the parser is not configured to ignore errors.

This exception may be thrown whenever one of the following options is disabled:

• GetOpt.IgnoreEmptyAppArgs
• GetOpt.IgnoreEmptyOptions
• GetOpt.IgnoreInvalidOptions
• GetOpt.IgnoreMissingArgument

Definition at line 14 of file ParseException.cs.

Constructor & Destructor Documentation

ParseException() [1/2]

getopt.net.ParseException.ParseException ( string  msg )

inline

Generic exception constructor; only accepts the error message.

Parameters

msg	A brief description of the error.

Definition at line 20 of file ParseException.cs.

: this(null, msg) { }

ParseException() [2/2]

getopt.net.ParseException.ParseException ( string?  optString, string  msg  )

inline

Specialsied exception constructor; accepts the option causing the error and an accompanying message.

Parameters

optString	The option that caused the exception.
msg	A brief description of the error.

Definition at line 27 of file ParseException.cs.

                                                            : base(msg) {
            Option = optString;
        }

Member Function Documentation

ToString()

override string getopt.net.ParseException.ToString ( )

inline

Definition at line 32 of file ParseException.cs.

                                          {
            if (string.IsNullOrEmpty(Option)) {
                return base.ToString();
            }
            return $"Error occurred while parsing { Option }: { Message }";
        }

Property Documentation

Option

string? getopt.net.ParseException.Option

getset

The option that caused the exception.

Definition at line 42 of file ParseException.cs.

{ get; set; }

---

The documentation for this class was generated from the following file:

• ParseException.cs