CsvConverterParseTResult(String, CsvToTResult, Char, Boolean, CsvOpts) Method

Parses a CSV-String.

Definition

Namespace: FolkerKinzel.CsvTools.Mappings
Assembly: FolkerKinzel.CsvTools.Mappings (in FolkerKinzel.CsvTools.Mappings.dll) Version: 1.1.0+1263e8243dc2cd78095f678f813d7d9c52ea4315

C#

public static TResult[] Parse<TResult>(
	string csv,
	CsvTo<TResult> converter,
	char delimiter = ',',
	bool isHeaderPresent = true,
	CsvOpts options = CsvOpts.Default
)

VB

Public Shared Function Parse(Of TResult) ( 
	csv As String,
	converter As CsvTo(Of TResult),
	Optional delimiter As Char = ","C,
	Optional isHeaderPresent As Boolean = true,
	Optional options As CsvOpts = CsvOpts.Default
) As TResult()

C++

public:
generic<typename TResult>
static array<TResult>^ Parse(
	String^ csv, 
	CsvTo<TResult>^ converter, 
	wchar_t delimiter = L',', 
	bool isHeaderPresent = true, 
	CsvOpts options = CsvOpts::Default
)

F#

static member Parse : 
        csv : string * 
        converter : CsvTo<'TResult> * 
        ?delimiter : char * 
        ?isHeaderPresent : bool * 
        ?options : CsvOpts 
(* Defaults:
        let _delimiter = defaultArg delimiter ','
        let _isHeaderPresent = defaultArg isHeaderPresent true
        let _options = defaultArg options CsvOpts.Default
*)
-> 'TResult[]

Parameters

csv String: The CSV-String to parse.
converter CsvToTResult: An object that converts a CSV row to a TResult instance.
delimiter Char (Optional): The field separator character used in csv.
isHeaderPresent Boolean (Optional): true, to interpret the first line as a header, otherwise false.
options CsvOpts (Optional): Parsing options.

Type Parameters

TResult: Generic type parameter that specifies the Type of the items in the array that the method returns.

Return Value

TResult
An array of TResult instances, initialized from the parsed csv.

Remarks

Tip

The optimal parameters can be determined automatically with AnalyzeString(String, Header, Int32) - or use ParseAnalyzedTResult(String, CsvMapping, FuncObject, TResult, Header, Int32).

Exceptions

ArgumentNullException	csv or converter is null.
CsvFormatException	Invalid CSV. The interpretation depends on options.
FormatException	Parsing fails and Throwing is true.