M_CommandLine_Text_HelpText_RenderUsageTextAsLines__1

HelpText.RenderUsageTextAsLines(T) Method

Builds a string sequence with usage text block created using UsageAttribute data and metadata.

Namespace: CommandLine.Text
Assembly: CommandLine (in CommandLine.dll) Version: 0.0.0

Syntax

C#

public static IEnumerable<string> RenderUsageTextAsLines<T>(
	ParserResult<T> parserResult,
	Func<Example, Example> mapperFunc
)

VB

Public Shared Function RenderUsageTextAsLines(Of T) ( 
	parserResult As ParserResult(Of T),
	mapperFunc As Func(Of Example, Example)
) As IEnumerable(Of String)

C++

public:
generic<typename T>
static IEnumerable<String^>^ RenderUsageTextAsLines(
	ParserResult<T>^ parserResult, 
	Func<Example^, Example^>^ mapperFunc
)

F#

static member RenderUsageTextAsLines : 
        parserResult : ParserResult<'T> * 
        mapperFunc : Func<Example, Example> -> IEnumerable<string> 

Parameters

 

parserResult

Type: CommandLine.ParserResult(T)
A parsing computation result.

mapperFunc

Type: System.Func(Example, Example)
A mapping lambda normally used to translate text in other languages.

Type Parameters

 

T

Type of parsing computation result.

Return Value

Type: IEnumerable(String)
Resulting formatted text.

See Also

Reference

HelpText Class
CommandLine.Text Namespace