StreamWriter Class

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

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

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

The StreamWriter type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryStreamWriter(Stream)Initializes a new instance of the StreamWriter class for the specified stream, 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 on the specified path, using the default encoding and buffer size.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryStreamWriter(Stream, Encoding)Initializes a new instance of the StreamWriter class for the specified stream, 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 on the specified path, 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 LibraryStreamWriter(Stream, Encoding, Int32)Initializes a new instance of the StreamWriter class for the specified stream, 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 on the specified path, 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 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 LibraryAutoFlushGets 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 LibraryBaseStreamGets the underlying stream that interfaces with a backing store.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryEncodingGets the Encoding in which the output is written. (Overrides TextWriter.Encoding.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryFormatProviderGets an object that controls formatting. (Inherited from TextWriter.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryNewLineGets 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 LibraryDispose()Releases all resources used by the TextWriter object. (Inherited from TextWriter.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryDispose(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 LibraryEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryFinalizeAllows 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 LibraryFlushClears all buffers for the current writer and causes any buffered data to be written to the underlying stream. (Overrides TextWriter.Flush().)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetHashCodeServes as a hash function for a particular type. (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 LibraryGetTypeGets 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 LibraryMemberwiseClone()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 LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Boolean)Writes the text representation of a Boolean value to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Char)Writes a character to the stream. (Overrides TextWriter.Write(Char).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Char[])Writes a character array to the stream. (Overrides TextWriter.Write(Char[]).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Decimal)Writes the text representation of a decimal value to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Double)Writes the text representation of an 8-byte floating-point value to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Int32)Writes the text representation of a 4-byte signed integer to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Int64)Writes the text representation of an 8-byte signed integer to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Object)Writes the text representation of an object to the text stream by calling ToString on that object. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Single)Writes the text representation of a 4-byte floating-point value to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(String)Writes a string to the stream. (Overrides TextWriter.Write(String).)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(UInt32)Writes the text representation of a 4-byte unsigned integer to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(UInt64)Writes the text representation of an 8-byte unsigned integer to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkWrite(String, Object)Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(String, Object[])Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Char[], Int32, Int32)Writes a subarray of characters to the stream. (Overrides TextWriter.Write(Char[], Int32, Int32).)
Public methodSupported by the XNA FrameworkWrite(String, Object, Object)Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public methodWrite(String, Object, Object, Object)Writes out a formatted string, using the same semantics as String.Format. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine()Writes a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Boolean)Writes the text representation of a Boolean followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Char)Writes a character followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Char[])Writes an array of characters followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Decimal)Writes the text representation of a decimal value followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Double)Writes the text representation of a 8-byte floating-point value followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Int32)Writes the text representation of a 4-byte signed integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Int64)Writes the text representation of an 8-byte signed integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Object)Writes the text representation of an object by calling ToString on this object, followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(Single)Writes the text representation of a 4-byte floating-point value followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(String)Writes a string followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(UInt32)Writes the text representation of a 4-byte unsigned integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteLine(UInt64)Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkWriteLine(String, 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 LibraryWriteLine(String, 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 LibraryWriteLine(Char[], Int32, Int32)Writes a subarray of characters followed by a line terminator to the text stream. (Inherited from TextWriter.)
Public methodSupported by the XNA FrameworkWriteLine(String, Object, Object)Writes out a formatted string and a new line, using the same semantics as Format. (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.)
Top

  NameDescription
Protected fieldSupported by the XNA FrameworkSupported by Portable Class LibraryCoreNewLineStores the new line characters used for this TextWriter. (Inherited from TextWriter.)
Public fieldStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryNullProvides a StreamWriter with no backing store that can be written to, but not read from.
Top

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

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. To create a StreamWriter using UTF-8 encoding and a BOM, consider using a constructor that specifies encoding, such as StreamWriter(String, Boolean, Encoding).

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.


using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.IO;

namespace StreamReadWrite
{
    class Program
    {
        static void Main(string[] args)
        {
            // Get the directories currently on the C drive.
            DirectoryInfo[] cDirs = new DirectoryInfo(@"c:\").GetDirectories();

            // Write each directory name to a file.
            using (StreamWriter sw = new StreamWriter("CDriveDirs.txt"))
            {
                foreach (DirectoryInfo dir in cDirs)
                {
                    sw.WriteLine(dir.Name);

                }
            }

            // Read and show each line from the file.
            string line = "";
            using (StreamReader sr = new StreamReader("CDriveDirs.txt"))
            {
                while ((line = sr.ReadLine()) != null)
                {
                    Console.WriteLine(line);
                }
            }
        }
    }
}


.NET Framework

Supported in: 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

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft