CommandLineBuilderExtensions.UseHelpBuilder<TBuilder> Method

Reference

Definition

Namespace:: System.CommandLine.Builder

Assembly:: System.CommandLine.dll

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.

Specifies an HelpBuilder to be used to format help output when help is requested.

public:
generic <typename TBuilder>
 where TBuilder : System::CommandLine::Builder::CommandLineBuilder[System::Runtime::CompilerServices::Extension]
 static TBuilder UseHelpBuilder(TBuilder builder, Func<System::CommandLine::Binding::BindingContext ^, System::CommandLine::Help::HelpBuilder ^> ^ getHelpBuilder);

public static TBuilder UseHelpBuilder<TBuilder> (this TBuilder builder, Func<System.CommandLine.Binding.BindingContext,System.CommandLine.Help.HelpBuilder> getHelpBuilder) where TBuilder : System.CommandLine.Builder.CommandLineBuilder;

static member UseHelpBuilder : 'Builder * Func<System.CommandLine.Binding.BindingContext, System.CommandLine.Help.HelpBuilder> -> 'Builder (requires 'Builder :> System.CommandLine.Builder.CommandLineBuilder)

<Extension()>
Public Function UseHelpBuilder(Of TBuilder As CommandLineBuilder) (builder As TBuilder, getHelpBuilder As Func(Of BindingContext, HelpBuilder)) As TBuilder

Type Parameters

TBuilder

Parameters

builder: TBuilder

A command line builder.

getHelpBuilder: Func<BindingContext,HelpBuilder>

A delegate that returns an instance of HelpBuilder

Returns

TBuilder

The same instance of CommandLineBuilder.

Applies to

Share via