ParseResultHelpRequested Property

Gets a value that indicates whether usage help should be displayed if the CommandLineParserParse(String) method returned .

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 5.0.0+724ca9b7fa5edc075ec2ae65044e61b0d494fd1c

C#

public bool HelpRequested { get; }

VB

Public ReadOnly Property HelpRequested As Boolean
	Get

Dim instance As ParseResult
Dim value As Boolean

value = instance.HelpRequested

C++

public:
property bool HelpRequested {
	bool get ();
}

Boolean
if usage help should be displayed; otherwise, .

Check this property after parsing the command line arguments to see if usage help should be displayed.

This property will always be if the Status property is ParseStatusSuccess.

This property will always be if the parsing command line arguments threw a CommandLineArgumentException, or if an argument used CancelModeAbortWithHelp with the CommandLineArgumentAttributeCancelParsing property, the CommandLineParserArgumentParsed event, or as the return value of a method argument.