FileSystem.OpenTextFileWriter Method (String, Boolean)

 

Opens a StreamWriter object to write to the specified file.

Namespace:   Microsoft.VisualBasic.FileIO
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

public static StreamWriter OpenTextFileWriter(
	string file,
	bool append
)

Parameters

file
Type: System.String

File to be written to.

append
Type: System.Boolean

True to append to the contents of the file; False to overwrite the contents of the file. Default is False.

Return Value

Type: System.IO.StreamWriter

StreamWriter object to write to the specified file.

Exception Condition
ArgumentException

The file name ends with a trailing slash.

The OpenTextFileWriter method opens and initializes a stream for a file and then returns the StreamWriter object for that stream. You can write to the steam as many times as necessary and then close it when you are finished.

System_CAPS_noteNote

You must call the Close method on the StreamWriter object to make sure that all data is correctly written to the underlying stream.

If you are writing only a few strings to a file, it might be simpler to use the WriteAllText method.

The following table lists an example of a task involving the My.Computer.FileSystem.OpenTextFileWriter method.

To

See

Write text to a file with a StreamWriter

How to: Write Text to Files with a StreamWriter in Visual Basic

This example opens a StreamWriter with the My.Computer.FileSystem.OpenTextFileWriter method and uses it to write a string to a text file with the WriteLine method of the StreamWriter class.

Dim file = My.Computer.FileSystem.OpenTextFileWriter(
    "c:\test.txt", True)
file.WriteLine("Here is the first string.")
file.Close()

FileIOPermission

Controls the ability to access files and folders. Associated enumeration: Unrestricted.

.NET Framework
Available since 2.0
Return to top
Show: