Skip to content

M_CommandLine_Text_HelpText_RenderUsageText__1_1

Moh.Hassan edited this page Oct 10, 2019 · 1 revision

HelpText.RenderUsageText(T) Method (ParserResult(T), Func(Example, Example))

Builds a string 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 string RenderUsageText<T>(
	ParserResult<T> parserResult,
	Func<Example, Example> mapperFunc
)

VB

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

C++

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

F#

static member RenderUsageText : 
        parserResult : ParserResult<'T> * 
        mapperFunc : Func<Example, Example> -> 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: String
Resulting formatted text.

See Also

Reference

HelpText Class
RenderUsageText Overload
CommandLine.Text Namespace

Clone this wiki locally