HelpBuilder.Default.GetIdentifierSymbolUsageLabel Method

Definition

Namespace:

System.CommandLine.Help

Assembly:

System.CommandLine.dll

Package:

System.CommandLine v2.0.0-beta4.22272.1

Source:

HelpBuilder.Default.cs

Gets the usage label for the specified symbol (typically used as the first column text in help output).

public:
 static System::String ^ GetIdentifierSymbolUsageLabel(System::CommandLine::IdentifierSymbol ^ symbol, System::CommandLine::Help::HelpContext ^ context);

public static string GetIdentifierSymbolUsageLabel(System.CommandLine.IdentifierSymbol symbol, System.CommandLine.Help.HelpContext context);

static member GetIdentifierSymbolUsageLabel : System.CommandLine.IdentifierSymbol * System.CommandLine.Help.HelpContext -> string

Public Shared Function GetIdentifierSymbolUsageLabel (symbol As IdentifierSymbol, context As HelpContext) As String

Parameters

symbol

IdentifierSymbol

The symbol to get a help item for.

context

HelpContext

The help context, used for localization purposes.

Returns

String

Text to display.