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.

Комментарии

Указанные псевдонимы переопределяют значения по умолчанию.