M_CommandLine_Text_HelpText_RenderParsingErrorsTextAsLines__1

HelpText.RenderParsingErrorsTextAsLines(T) Method

Builds a sequence of string that contains a parsing error message.

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

Syntax

C#

public static IEnumerable<string> RenderParsingErrorsTextAsLines<T>(
	ParserResult<T> parserResult,
	Func<Error, string> formatError,
	Func<IEnumerable<MutuallyExclusiveSetError>, string> formatMutuallyExclusiveSetErrors,
	int indent
)

VB

Public Shared Function RenderParsingErrorsTextAsLines(Of T) ( 
	parserResult As ParserResult(Of T),
	formatError As Func(Of Error, String),
	formatMutuallyExclusiveSetErrors As Func(Of IEnumerable(Of MutuallyExclusiveSetError), String),
	indent As Integer
) As IEnumerable(Of String)

C++

public:
generic<typename T>
static IEnumerable<String^>^ RenderParsingErrorsTextAsLines(
	ParserResult<T>^ parserResult, 
	Func<Error^, String^>^ formatError, 
	Func<IEnumerable<MutuallyExclusiveSetError^>^, String^>^ formatMutuallyExclusiveSetErrors, 
	int indent
)

F#

static member RenderParsingErrorsTextAsLines : 
        parserResult : ParserResult<'T> * 
        formatError : Func<Error, string> * 
        formatMutuallyExclusiveSetErrors : Func<IEnumerable<MutuallyExclusiveSetError>, string> * 
        indent : int -> IEnumerable<string> 

Parameters

 

parserResult

Type: CommandLine.ParserResult(T)
The ParserResult(T) containing the instance that collected command line arguments parsed with Parser class.

formatError

Type: System.Func(Error, String)
The error formatting delegate.

formatMutuallyExclusiveSetErrors

Type: System.Func(IEnumerable(MutuallyExclusiveSetError), String)
The specialized MutuallyExclusiveSetError sequence formatting delegate.

indent

Type: System.Int32
Number of spaces used to indent text.

Type Parameters

 

T

Return Value

Type: IEnumerable(String)
A sequence of String that contains the parsing error message.

See Also

Reference

HelpText Class
CommandLine.Text Namespace