UsageWriterWriteAliases Method

protected virtual void WriteAliases(
	IEnumerable<AliasAttribute>? aliases,
	IEnumerable<ShortAliasAttribute>? shortAliases,
	string prefix,
	string shortPrefix
)

Protected Overridable Sub WriteAliases ( 
	aliases As IEnumerable(Of AliasAttribute),
	shortAliases As IEnumerable(Of ShortAliasAttribute),
	prefix As String,
	shortPrefix As String
)

Dim aliases As IEnumerable(Of AliasAttribute)
Dim shortAliases As IEnumerable(Of ShortAliasAttribute)
Dim prefix As String
Dim shortPrefix As String

Me.WriteAliases(aliases, shortAliases, 
	prefix, shortPrefix)

protected:
virtual void WriteAliases(
	IEnumerable<AliasAttribute^>^ aliases, 
	IEnumerable<ShortAliasAttribute^>^ shortAliases, 
	String^ prefix, 
	String^ shortPrefix
)

Parameters

aliases  IEnumerableAliasAttribute

The aliases of an argument, or the long aliases for ParsingModeLongShort mode, or if the argument has no (long) aliases.

shortAliases  IEnumerableShortAliasAttribute

The short aliases of an argument, or if the argument has no short aliases.

prefix  String

The argument name prefix to use for the aliases.

shortPrefix  String

The argument name prefix to use for the shortAliases.

The base implementation writes a list of the short aliases, followed by the long aliases, surrounded by parentheses, and preceded by a single space. For example, " (-Alias1, -Alias2)" or " (-a, -b, --alias1, --alias2)".

If there are no aliases at all, it writes nothing.

This method is called by the base implementation of the WriteArgumentDescription(CommandLineArgument) method if the IncludeAliasInDescription property is .

Reference