TextFieldParser Constructor

Initializes a new instance of the TextFieldParser class.

' Usage
Dim value As New TextFieldParser(path)
Dim value As New TextFieldParser(path, defaultEncoding)
Dim value As New TextFieldParser(path, defaultEncoding, detectEncoding)
Dim value As New TextFieldParser(stream)
Dim value As New TextFieldParser(stream, defaultEncoding)
Dim value As New TextFieldParser(stream, defaultEncoding, detectEncoding)
Dim value As New TextFieldParser(stream, defaultEncoding, detectEncoding, leaveOpen)
Dim value As New TextFieldParser(reader)
' Declaration
Public Sub New( _
   ByVal path As String _
)
' -or-
Public Sub New( _
   ByVal path As String, _
   ByVal defaultEncoding As System.Text.Encoding _
)
' -or-
Public Sub New( _
   ByVal path As String, _
   ByVal defaultEncoding As System.Text.Encoding, _
   ByVal detectEncoding As Boolean _
)
' -or-
Public Sub New( _
   ByVal stream As Stream _
)
' -or-
Public Sub New( _
   ByVal stream As Stream, _
   ByVal defaultEncoding As System.Text.Encoding _
)
' -or-
Public Sub New( _
   ByVal stream As Stream, _
   ByVal defaultEncoding As System.Text.Encoding, _
   ByVal detectEncoding As Boolean _
)
' -or-
Public Sub New( _
   ByVal stream As Stream, _
   ByVal defaultEncoding As System.Text.Encoding, _
   ByVal detectEncoding As Boolean, _
   ByVal leaveOpen As Boolean _
)
' -or-
Public Sub New( _
   ByVal reader As TextReader _
)

Parameters

  • path
    String. The complete path of the file to be parsed.

  • stream
    Stream. The stream to be parsed.

  • defaultEncoding
    Encoding. The character encoding to use if encoding is not determined from file. Default is UTF8.

  • detectEncoding
    Boolean. Indicates whether to look for byte order marks at the beginning of the file. Default is True.

  • leaveOpen
    Boolean. Indicates whether to leave stream open when the TextFieldParser object is closed. Default is False.

  • reader
    TextReader. The TextReader stream to be parsed.

Remarks

Creates a new TextFieldParser object to parse the file or stream represented by the path, stream, or reader parameters.

If the defaultEncoding parameter is specified, this constructor uses it as the default encoding.

If the detectEncoding parameter is True, this constructor attempts to detect the encoding by looking at the first three bytes of the file or stream. It automatically recognizes UTF-8, little-endian Unicode, and big-endian Unicode text if the file starts with the appropriate byte-order marks. Otherwise, the encoding specified by defaultEncoding is used.

Warning

When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable and could cause an exception to be thrown.

Requirements

Namespace:Microsoft.VisualBasic.FileIO

Class:TextFieldParser

Assembly: Visual Basic Runtime Library (in Microsoft.VisualBasic.dll)

Permissions

No permissions are required.

See Also

Tasks

How to: Read From Comma-Delimited Text Files in Visual Basic

How to: Read From Fixed-width Text Files in Visual Basic

How to: Read From Text Files with Multiple Formats in Visual Basic

Reference

TextFieldParser Object

TextFieldParser.TextFieldParser