CsvOpenWrite(String, IReadOnlyCollectionString, Char, Encoding) Method

public static CsvWriter OpenWrite(
	string filePath,
	IReadOnlyCollection<string?> columnNames,
	char delimiter = ',',
	Encoding? textEncoding = null
)

Public Shared Function OpenWrite ( 
	filePath As String,
	columnNames As IReadOnlyCollection(Of String),
	Optional delimiter As Char = ","C,
	Optional textEncoding As Encoding = Nothing
) As CsvWriter

public:
static CsvWriter^ OpenWrite(
	String^ filePath, 
	IReadOnlyCollection<String^>^ columnNames, 
	wchar_t delimiter = L',', 
	Encoding^ textEncoding = nullptr
)

static member OpenWrite : 
        filePath : string * 
        columnNames : IReadOnlyCollection<string> * 
        ?delimiter : char * 
        ?textEncoding : Encoding 
(* Defaults:
        let _delimiter = defaultArg delimiter ','
        let _textEncoding = defaultArg textEncoding null
*)
-> CsvWriter 

Parameters

filePath  String

File path of the CSV file.

columnNames  IReadOnlyCollectionString

A collection of column names for the header to be written.

The collection determines the order in which the columns appear in the CSV file and their index in CsvRecord. The Record of the CsvWriter instance, which the method returns, can be accessed with this column names.

The collection will be copied. If the collection contains null values, empty strings or white space, these are replaced by automatically generated column names. Column names cannot appear twice. By default the comparison is case-sensitive but it will be reset to a case-insensitive comparison if the column names are also unique when treated case-insensitive.

delimiter  Char  (Optional)

The field separator character.

textEncoding  Encoding  (Optional)

The text encoding to be used or null for UTF8.

Return Value

If the target file already exists, it is truncated and overwritten.

When exchanging CSV data with Excel, the appropriate arguments can be determined with GetExcelArguments.

Reference