CommandLineBuilderExtensions.UseHelp メソッド

定義

名前空間:

System.CommandLine.Builder

アセンブリ:

System.CommandLine.dll

オーバーロード

UseHelp(CommandLineBuilder, Nullable<Int32>)	コマンド ラインで次のいずれかのオプションが指定されている場合にヘルプを表示するようにアプリケーションを構成します。 -h /h --help -? /?
UseHelp(CommandLineBuilder, String[])	指定したオプションエイリアスのいずれかがコマンド ラインで使用されている場合にヘルプを表示するようにアプリケーションを構成します。
UseHelp(CommandLineBuilder, Action<HelpContext>, Nullable<Int32>)	指定したオプションエイリアスのいずれかがコマンド ラインで使用されている場合にヘルプを表示するようにアプリケーションを構成します。

UseHelp(CommandLineBuilder, Nullable<Int32>)

コマンド ラインで次のいずれかのオプションが指定されている場合にヘルプを表示するようにアプリケーションを構成します。

-h
/h
--help
-?
/?

public static System.CommandLine.Builder.CommandLineBuilder UseHelp (this System.CommandLine.Builder.CommandLineBuilder builder, int? maxWidth = default);

static member UseHelp : System.CommandLine.Builder.CommandLineBuilder * Nullable<int> -> System.CommandLine.Builder.CommandLineBuilder

<Extension()>
Public Function UseHelp (builder As CommandLineBuilder, Optional maxWidth As Nullable(Of Integer) = Nothing) As CommandLineBuilder

パラメーター

builder

CommandLineBuilder

コマンド ライン ビルダー。

maxWidth

Nullable<Int32>

既定のヘルプ ビルダーの最大出力幅。

戻り値

CommandLineBuilder

の同じインスタンス CommandLineBuilder。

UseHelp(CommandLineBuilder, String[])

指定したオプションエイリアスのいずれかがコマンド ラインで使用されている場合にヘルプを表示するようにアプリケーションを構成します。

public:
[System::Runtime::CompilerServices::Extension]
 static System::CommandLine::Builder::CommandLineBuilder ^ UseHelp(System::CommandLine::Builder::CommandLineBuilder ^ builder, ... cli::array <System::String ^> ^ helpAliases);

public static System.CommandLine.Builder.CommandLineBuilder UseHelp (this System.CommandLine.Builder.CommandLineBuilder builder, params string[] helpAliases);

static member UseHelp : System.CommandLine.Builder.CommandLineBuilder * string[] -> System.CommandLine.Builder.CommandLineBuilder

<Extension()>
Public Function UseHelp (builder As CommandLineBuilder, ParamArray helpAliases As String()) As CommandLineBuilder

パラメーター

builder

CommandLineBuilder

コマンド ライン ビルダー。

helpAliases

String[]

ヘルプを要求するためにコマンド ラインで指定できるエイリアスのセット。

戻り値

CommandLineBuilder

の同じインスタンス CommandLineBuilder。

注釈

指定したエイリアスによって既定値がオーバーライドされます。

UseHelp(CommandLineBuilder, Action<HelpContext>, Nullable<Int32>)

指定したオプションエイリアスのいずれかがコマンド ラインで使用されている場合にヘルプを表示するようにアプリケーションを構成します。

public static System.CommandLine.Builder.CommandLineBuilder UseHelp (this System.CommandLine.Builder.CommandLineBuilder builder, Action<System.CommandLine.Help.HelpContext> customize, int? maxWidth = default);

static member UseHelp : System.CommandLine.Builder.CommandLineBuilder * Action<System.CommandLine.Help.HelpContext> * Nullable<int> -> System.CommandLine.Builder.CommandLineBuilder

<Extension()>
Public Function UseHelp (builder As CommandLineBuilder, customize As Action(Of HelpContext), Optional maxWidth As Nullable(Of Integer) = Nothing) As CommandLineBuilder

パラメーター

builder

CommandLineBuilder

コマンド ライン ビルダー。

customize

Action<HelpContext>

ヘルプが要求された場合にヘルプをカスタマイズするために呼び出されるデリゲート。

maxWidth

Nullable<Int32>

既定のヘルプ ビルダーの最大出力幅。

戻り値

CommandLineBuilder

の同じインスタンス CommandLineBuilder。

注釈

指定したエイリアスによって既定値がオーバーライドされます。