FromCSVFile

Description

The FromCSVFile() method accepts a path argument pointing to a comma-separated values (CSV) file and stores the delimited values contained within to the internal array. Fields that contain a special character (comma, CR*, LF*, or double quote*), and are “escaped” by enclosing them in double quotes (Hex 22) are correctly handled as per the RFC 4180 specification.

Also see ws-garcia’s VBA-CSV-interface library if higher performance is required.

Syntax

expression.FromCSVFile(Path, [ColumnDelimiter], [RowDelimiter], [Quote], [IgnoreFirstRow], [DuckType])

Parameters

Name: Path
Type: String
Necessity: Required
Description: A valid path string to the target CSV file.

Name: ColumnDelimiter
Type: String
Necessity: Optional
Description: The character used to delimit columns within the CSV file. If omitted, the character , (comma) is used.

Name: RowDelimiter
Type: String
Necessity: Optional
Description: The character(s) used to delimit rows within the CSV file. If omitted, we try to guess the appropriate line ending and if we cannot default to vbCrLf.

Name: Quote
Type: String
Necessity: Optional
Description: The character(s) used to escape characters within cells of the CSV file. If omitted, the character " (double quote) is used indicate the opening and closing of an escape sqeuence.

Name: IgnoreFirstRow
Type: Boolean
Necessity: Optional
Description: If true, the first line of the CSV file will be skipped. Use this if your data has headers but you just want to return the data body.

Name: DuckType
Type: Boolean
Necessity: Optional
Description: If true, numeric and boolean values will be correctly converted to the appropriate type. If false all values will be String. Leave false if you just intend to output the values to an Excel worksheet as Excel will perform the type conversion automatically.

Returns

Type: BetterArray / Object
Description: The current instance of the BetterArray object with the data from the parsed CSV stored in the internal array.

Example

Public Sub FromCSVFileExample()
    Dim MyArray As BetterArray
    Set MyArray = New BetterArray

    Dim path As String
    path = Strings.Join(Array(Environ("USERPROFILE"), "Desktop", "Data", "Sales Records.csv"), "\")

    Dim OutputSheet As Worksheet
    Set OutputSheet = ThisWorkbook.Sheets.Add
    MyArray.FromCSVFile(path).ToExcelRange OutputSheet.Range("A1")

    ' expected output:
    ' The data in the CSV was parsed into an array and written to a new worksheet in Excel
End Sub

Back to Docs