ParseResult.HelpRequested Property

Gets a value that indicates whether usage help should be displayed if the CommandLineParser.Parse(String[]) method returned null.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 5.0.0+724ca9b7fa5edc075ec2ae65044e61b0d494fd1c
C#
public bool HelpRequested { get; }

Property Value

Boolean
true if usage help should be displayed; otherwise, false.

Remarks

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

This property will always be false if the Status property is ParseStatus.Success.

This property will always be true if the parsing command line arguments threw a CommandLineArgumentException, or if an argument used CancelMode.AbortWithHelp with the CommandLineArgumentAttribute.CancelParsing property, the CommandLineParser.ArgumentParsed event, or as the return value of a method argument.

See Also