Export (0) Print
Expand All

StreamWriter Class

Implements a TextWriter for writing characters to a stream in a particular encoding.

To browse the .NET Framework source code for this type, see the Reference Source.

Namespace:  System.IO
Assembly:  mscorlib (in mscorlib.dll)

[SerializableAttribute]
[ComVisibleAttribute(true)]
public ref class StreamWriter : public TextWriter

The StreamWriter type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsStreamWriter(Stream)Initializes a new instance of the StreamWriter class for the specified stream by using UTF-8 encoding and the default buffer size.
Public methodSupported by the XNA FrameworkStreamWriter(String)Initializes a new instance of the StreamWriter class for the specified file by using the default encoding and buffer size.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsStreamWriter(Stream, Encoding)Initializes a new instance of the StreamWriter class for the specified stream by using the specified encoding and the default buffer size.
Public methodSupported by the XNA FrameworkStreamWriter(String, Boolean)Initializes a new instance of the StreamWriter class for the specified file by using the default encoding and buffer size. If the file exists, it can be either overwritten or appended to. If the file does not exist, this constructor creates a new file.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsStreamWriter(Stream, Encoding, Int32)Initializes a new instance of the StreamWriter class for the specified stream by using the specified encoding and buffer size.
Public methodSupported by the XNA FrameworkStreamWriter(String, Boolean, Encoding)Initializes a new instance of the StreamWriter class for the specified file by using the specified encoding and default buffer size. If the file exists, it can be either overwritten or appended to. If the file does not exist, this constructor creates a new file.
Public methodSupported in .NET for Windows Store appsStreamWriter(Stream, Encoding, Int32, Boolean)Initializes a new instance of the StreamWriter class for the specified stream by using the specified encoding and buffer size, and optionally leaves the stream open.
Public methodSupported by the XNA FrameworkStreamWriter(String, Boolean, Encoding, Int32)Initializes a new instance of the StreamWriter class for the specified file on the specified path, using the specified encoding and buffer size. If the file exists, it can be either overwritten or appended to. If the file does not exist, this constructor creates a new file.
Top

  NameDescription
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsAutoFlushGets or sets a value indicating whether the StreamWriter will flush its buffer to the underlying stream after every call to StreamWriter::Write.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsBaseStreamGets the underlying stream that interfaces with a backing store.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsEncodingGets the Encoding in which the output is written. (Overrides TextWriter::Encoding.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsFormatProviderGets an object that controls formatting. (Inherited from TextWriter.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsNewLineGets or sets the line terminator string used by the current TextWriter. (Inherited from TextWriter.)
Top

  NameDescription
Public methodSupported by the XNA FrameworkCloseCloses the current StreamWriter object and the underlying stream. (Overrides TextWriter::Close().)
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsDispose()Releases all resources used by the TextWriter object. (Inherited from TextWriter.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsDispose(Boolean)Releases the unmanaged resources used by the StreamWriter and optionally releases the managed resources. (Overrides TextWriter::Dispose(Boolean).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsFlushClears all buffers for the current writer and causes any buffered data to be written to the underlying stream. (Overrides TextWriter::Flush().)
Public methodSupported in .NET for Windows Store appsFlushAsyncClears all buffers for this stream asynchronously and causes any buffered data to be written to the underlying device. (Overrides TextWriter::FlushAsync().)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Boolean)Writes the text representation of a Boolean value to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Char)Writes a character to the stream. (Overrides TextWriter::Write(Char).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(array<Char>)Writes a character array to the stream. (Overrides TextWriter::Write(array<Char>).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Decimal)Writes the text representation of a decimal value to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Double)Writes the text representation of an 8-byte floating-point value to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Int32)Writes the text representation of a 4-byte signed integer to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Int64)Writes the text representation of an 8-byte signed integer to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Object)Writes the text representation of an object to the text string or stream by calling the ToString method on that object. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(Single)Writes the text representation of a 4-byte floating-point value to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(String)Writes a string to the stream. (Overrides TextWriter::Write(String).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(UInt32)Writes the text representation of a 4-byte unsigned integer to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(UInt64)Writes the text representation of an 8-byte unsigned integer to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkWrite(String, Object)Writes a formatted string to the text string or stream, using the same semantics as the String::Format(String, Object) method. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(String, array<Object>)Writes a formatted string to the text string or stream, using the same semantics as the String::Format(String, array<Object>) method. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWrite(array<Char>, Int32, Int32)Writes a subarray of characters to the stream. (Overrides TextWriter::Write(array<Char>, Int32, Int32).)
Public methodSupported by the XNA FrameworkWrite(String, Object, Object)Writes a formatted string to the text string or stream, using the same semantics as the String::Format(String, Object, Object) method. (Inherited from TextWriter.)
Public methodWrite(String, Object, Object, Object)Writes a formatted string to the text string or stream, using the same semantics as the String::Format(String, Object, Object, Object) method. (Inherited from TextWriter.)
Public methodSupported in .NET for Windows Store appsWriteAsync(Char)Writes a character to the stream asynchronously. (Overrides TextWriter::WriteAsync(Char).)
Public methodSupported in .NET for Windows Store appsWriteAsync(array<Char>)Writes a character array to the text string or stream asynchronously. (Inherited from TextWriter.)
Public methodSupported in .NET for Windows Store appsWriteAsync(String)Writes a string to the stream asynchronously. (Overrides TextWriter::WriteAsync(String).)
Public methodSupported in .NET for Windows Store appsWriteAsync(array<Char>, Int32, Int32)Writes a subarray of characters to the stream asynchronously. (Overrides TextWriter::WriteAsync(array<Char>, Int32, Int32).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine()Writes a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Boolean)Writes the text representation of a Boolean value followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Char)Writes a character followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(array<Char>)Writes an array of characters followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Decimal)Writes the text representation of a decimal value followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Double)Writes the text representation of a 8-byte floating-point value followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Int32)Writes the text representation of a 4-byte signed integer followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Int64)Writes the text representation of an 8-byte signed integer followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Object)Writes the text representation of an object by calling the ToString method on that object, followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(Single)Writes the text representation of a 4-byte floating-point value followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(String)Writes a string followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(UInt32)Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(UInt64)Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkWriteLine(String, Object)Writes a formatted string and a new line to the text string or stream, using the same semantics as the String::Format(String, Object) method. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(String, array<Object>)Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsWriteLine(array<Char>, Int32, Int32)Writes a subarray of characters followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkWriteLine(String, Object, Object)Writes a formatted string and a new line to the text string or stream, using the same semantics as the String::Format(String, Object, Object) method. (Inherited from TextWriter.)
Public methodWriteLine(String, Object, Object, Object)Writes out a formatted string and a new line, using the same semantics as Format. (Inherited from TextWriter.)
Public methodSupported in .NET for Windows Store appsWriteLineAsync()Writes a line terminator asynchronously to the stream. (Overrides TextWriter::WriteLineAsync().)
Public methodSupported in .NET for Windows Store appsWriteLineAsync(Char)Writes a character followed by a line terminator asynchronously to the stream. (Overrides TextWriter::WriteLineAsync(Char).)
Public methodSupported in .NET for Windows Store appsWriteLineAsync(array<Char>)Writes an array of characters followed by a line terminator asynchronously to the text string or stream. (Inherited from TextWriter.)
Public methodSupported in .NET for Windows Store appsWriteLineAsync(String)Writes a string followed by a line terminator asynchronously to the stream. (Overrides TextWriter::WriteLineAsync(String).)
Public methodSupported in .NET for Windows Store appsWriteLineAsync(array<Char>, Int32, Int32)Writes a subarray of characters followed by a line terminator asynchronously to the stream. (Overrides TextWriter::WriteLineAsync(array<Char>, Int32, Int32).)
Top

  NameDescription
Protected fieldSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsCoreNewLineStores the newline characters used for this TextWriter. (Inherited from TextWriter.)
Public fieldStatic memberSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsNullProvides a StreamWriter with no backing store that can be written to, but not read from.
Top

NoteNote

To view the .NET Framework source code for this type, see the Reference Source. You can browse through the source code online, download the reference for offline viewing, and step through the sources (including patches and updates) during debugging; see instructions.

StreamWriter is designed for character output in a particular encoding, whereas classes derived from Stream are designed for byte input and output.

Important noteImportant

This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the “Using an Object that Implements IDisposable” section in the IDisposable interface topic.

StreamWriter defaults to using an instance of UTF8Encoding unless specified otherwise. This instance of UTF8Encoding is constructed 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 a BOM and determine whether an exception is thrown on invalid bytes, use a constructor that accepts an encoding object as a parameter, such as StreamWriter(String, Boolean, Encoding) or StreamWriter.

By default, a StreamWriter is not thread safe. See TextWriter::Synchronized for a thread-safe wrapper.

For a list of common I/O tasks, see Common I/O Tasks.

The following example shows how to use a StreamWriter object to write a file that lists the directories on the C drive, and then uses a StreamReader object to read and display each directory name. A good practice is to use these objects in a using statement so that the unmanaged resources are correctly disposed. The using statement automatically calls Dispose on the object when the code that is using it has completed. The constructor used in this example is not supported for use in Windows Store Apps.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft