CancelMode Enumeration

Indicates whether and how an argument should cancel parsing.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83
C#
public enum CancelMode

Members

None0 The argument does not cancel parsing.
Abort1 The argument cancels parsing, discarding the results so far. Parsing, using for example the CommandLineParser.Parse<T>(ParseOptions) method, will return a null value. The ParseResult.Status property will be ParseStatus.Canceled.
Success2 The argument cancels parsing, returning success using the results so far. Remaining arguments are not parsed, and will be available in the ParseResult.RemainingArguments property. The ParseResult.Status property will be ParseStatus.Success. If not all required arguments have values at this point, an exception will be thrown.

See Also