Models an error generated when a user explicitly requests help in verb commands scenario. More...

Inheritance diagram for CommandLine.HelpVerbRequestedError:

Package Functions
	HelpVerbRequestedError (string verb, Type type, bool matched)

Package Functions inherited from CommandLine.Error
	Error (ErrorType tag, bool stopsProcessing)
	Initializes a new instance of the CommandLine.Error class.

	Error (ErrorType tag)
	Initializes a new instance of the CommandLine.Error class.

Properties
string	Verb `[get]`
	Verb command string.

Type	Type `[get]`
	System.Type of verb command.

bool	Matched `[get]`
	trueif verb command is found; otherwise false

Properties inherited from CommandLine.Error
ErrorType	Tag `[get]`
	Error type discriminator, defined as CommandLine.ErrorType enumeration.

bool	StopsProcessing `[get]`
	Tells if error stops parsing process. Filtered by CommandLine.ErrorExtensions.OnlyMeaningfulOnes(System.Collections.Generic.IEnumerable<Error>).

Additional Inherited Members
Public Member Functions inherited from CommandLine.Error
bool	Equals (Error other)
	Returns a value that indicates whether the current instance and a specified CommandLine.Error have the same value.

override bool	Equals (object obj)
	Determines whether the specified System.Object is equal to the current System.Object.

override int	GetHashCode ()
	Serves as a hash function for a particular type.

Detailed Description

Models an error generated when a user explicitly requests help in verb commands scenario.

Definition at line 462 of file Error.cs.

Constructor & Destructor Documentation

◆ HelpVerbRequestedError()

CommandLine.HelpVerbRequestedError.HelpVerbRequestedError	(	string	verb,
		Type	type,
		bool	matched
	)

package

Definition at line 464 of file Error.cs.

            : base(ErrorType.HelpVerbRequestedError, true)
        {
            Verb = verb;
            Type = type;
            Matched = matched;
        }

Property Documentation

◆ Matched

bool CommandLine.HelpVerbRequestedError.Matched

get

trueif verb command is found; otherwise false

Definition at line 488 of file Error.cs.

488{ get; }

◆ Type

Type CommandLine.HelpVerbRequestedError.Type

get

System.Type of verb command.

Definition at line 480 of file Error.cs.

480{ get; }

◆ Verb

string CommandLine.HelpVerbRequestedError.Verb

get

Verb command string.

Definition at line 475 of file Error.cs.

475{ get; }

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

deps/commandlineparser/src/CommandLine/Error.cs

Package Functions

Properties