CsvAnalyzerAnalyzeFile Method

public static CsvAnalyzerResult AnalyzeFile(
	string filePath,
	Encoding? textEncoding = null,
	Header header = Header.ProbablyPresent,
	int analyzedLines = 5
)

Public Shared Function AnalyzeFile ( 
	filePath As String,
	Optional textEncoding As Encoding = Nothing,
	Optional header As Header = Header.ProbablyPresent,
	Optional analyzedLines As Integer = 5
) As CsvAnalyzerResult

public:
static CsvAnalyzerResult^ AnalyzeFile(
	String^ filePath, 
	Encoding^ textEncoding = nullptr, 
	Header header = Header::ProbablyPresent, 
	int analyzedLines = 5
)

static member AnalyzeFile : 
        filePath : string * 
        ?textEncoding : Encoding * 
        ?header : Header * 
        ?analyzedLines : int 
(* Defaults:
        let _textEncoding = defaultArg textEncoding null
        let _header = defaultArg header Header.ProbablyPresent
        let _analyzedLines = defaultArg analyzedLines 5
*)
-> CsvAnalyzerResult 

Parameters

filePath  String

File path of the CSV file.

textEncoding  Encoding  (Optional)

The text encoding to be used to read the CSV file, or null for UTF8.

  Tip

Use AnalyzeFile(String, Encoding, Header, Int32) to also automatically determine the Encoding.

header  Header  (Optional)

A supposition that is made about the presence of a header row.

analyzedLines  Int32  (Optional)

Maximum number of lines to analyze in the CSV file. The minimum value is AnalyzedLinesMinCount. If the file has fewer lines than analyzedLines, it will be analyzed completely. (You can specify Int32.MaxValue to analyze the entire file in any case.)

Return Value

CsvAnalyzer performs a statistical analysis on the CSV file to find the appropriate method arguments for reading the file. The result of the analysis is therefore always only an estimate, the accuracy of which increases with the number of lines analyzed. The analysis is time-consuming because the CSV file has to be accessed for reading.

The field delimiters COMMA (',', %x2C), SEMICOLON (';', %x3B), HASH ('#', %x23), TAB ('\t', %x09), and SPACE (' ', %x20) are recognized automatically.

Use AnalyzeFile(String, Encoding, Header, Int32) to analyze the textEncoding too.

Reference