CancelMode Enumeration

Indicates whether and how an argument should cancel parsing.

Definition

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

C#

public enum CancelMode

VB

Public Enumeration CancelMode

Dim instance As CancelMode

C++

public enum class CancelMode

None	0	The argument does not cancel parsing.
Abort	1	The argument cancels parsing, discarding the results so far. Parsing, using for example the CommandLineParserParseT(ParseOptions) method, will return a value. The ParseResultStatus property will be ParseStatusCanceled. The ParseResultHelpRequested property will be .
AbortWithHelp	2	The same as Abort, but the ParseResultHelpRequested property will be .
Success	3	The argument cancels parsing, returning success using the results so far. Remaining arguments are not parsed, and will be available in the ParseResultRemainingArguments property. The ParseResultStatus property will be ParseStatusSuccess. If not all required arguments have values at this point, an exception will be thrown.