CommandLineBuilderExtensions.EnableLegacyDoubleDashBehavior Method

Reference

Definition

Namespace:: System.CommandLine.Builder

Assembly:: System.CommandLine.dll

Package:: System.CommandLine v2.0.0-beta4.22272.1

Source:: CommandLineBuilderExtensions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Determines the behavior when parsing a double dash (--) in a command line.

public static System.CommandLine.Builder.CommandLineBuilder EnableLegacyDoubleDashBehavior(this System.CommandLine.Builder.CommandLineBuilder builder, bool value = true);

static member EnableLegacyDoubleDashBehavior : System.CommandLine.Builder.CommandLineBuilder * bool -> System.CommandLine.Builder.CommandLineBuilder

<Extension()>
Public Function EnableLegacyDoubleDashBehavior (builder As CommandLineBuilder, Optional value As Boolean = true) As CommandLineBuilder

Parameters

builder: CommandLineBuilder

A command line builder.

value: Boolean

true to place all tokens following -- into the UnparsedTokens collection. false to treat all tokens following -- as command arguments, even if they match an existing option.

Returns

CommandLineBuilder

Remarks

When set to true, all tokens following -- will be placed into the UnparsedTokens collection. When set to false, all tokens following -- will be treated as command arguments, even if they match an existing option.

Applies to