CommandLineArgumentAttribute.CancelParsing Property

public CancelMode CancelParsing { get; set; }

Public Property CancelParsing As CancelMode
	Get
	Set

Dim instance As CommandLineArgumentAttribute
Dim value As CancelMode

value = instance.CancelParsing
instance.CancelParsing = value

public:
property CancelMode CancelParsing {
	CancelMode get ();
	void set (CancelMode value);
}

Property Value

If this property is not CancelMode.None, the CommandLineParser will stop parsing the command line arguments after seeing this argument. The result of the operation will be null if this property is CancelMode.Abort, or an instance of the arguments class with the results up to this point if this property is CancelMode.Success. In the latter case, the ParseResult.RemainingArguments property will contain all arguments that were not parsed.

If CancelMode.Success is used, all required arguments must have a value at the point this argument is encountered, otherwise a CommandLineArgumentException is thrown.

Use the ParseResult.ArgumentName property to determine which argument caused cancellation.

If this property is CancelMode.Abort, the CommandLineParser.HelpRequested property will be automatically set to true when parsing is canceled.

It's possible to prevent cancellation when an argument has this property set by handling the CommandLineParser.ArgumentParsed event and setting the ArgumentParsedEventArgs.CancelParsing property to CancelMode.None.

Reference