StreamWriter Constructor (Stream)
Initializes a new instance of the StreamWriter class for the specified stream by using UTF-8 encoding and the default buffer size.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- stream
-
Type:
System.IO.Stream
The stream to write to.
| Exception | Condition |
|---|---|
| ArgumentException | stream is not writable. |
| ArgumentNullException | stream is null. |
This constructor creates a StreamWriter with UTF-8 encoding without a Byte-Order Mark (BOM), so its GetPreamble method returns an empty byte array. The default UTF-8 encoding for this constructor throws an exception on invalid bytes. This behavior is different from the behavior provided by the encoding object in the Encoding.UTF8 property. To specify whether an exception is thrown on invalid bytes, use a constructor that accepts an encoding object as a parameter, such as StreamWriter. The BaseStream property is initialized using the stream parameter. The position of the stream is not reset.
The StreamWriter object calls Dispose() on the provided Stream object when StreamWriter.Dispose is called.
Caution |
|---|
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. |
For a list of common I/O tasks, see Common I-O Tasks.
The following code example demonstrates this constructor.
Imports System.IO Module Module1 Sub Main() Dim fileName As String = "test.txt" Dim textToAdd As String = "Example text in file" Dim fs As FileStream = Nothing Try fs = New FileStream(fileName, FileMode.CreateNew) Using writer As StreamWriter = New StreamWriter(fs) writer.Write(textToAdd) End Using Finally If Not fs Is Nothing Then fs.Dispose() End If End Try End Sub End Module
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
