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)

System.Object
  System.MarshalByRefObject
    System.IO.TextWriter
      System.IO.StreamWriter

[<SerializableAttribute>]
[<ComVisibleAttribute(true)>]
type StreamWriter = 
    class
        inherit TextWriter
    end

NameDescription
System_CAPS_pubmethodStreamWriter(Stream)

Initializes a new instance of the StreamWriter class for the specified stream by using UTF-8 encoding and the default buffer size.

System_CAPS_pubmethodStreamWriter(Stream, Encoding)

Initializes a new instance of the StreamWriter class for the specified stream by using the specified encoding and the default buffer size.

System_CAPS_pubmethodStreamWriter(Stream, Encoding, Int32)

Initializes a new instance of the StreamWriter class for the specified stream by using the specified encoding and buffer size.

System_CAPS_pubmethodStreamWriter(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.

System_CAPS_pubmethodStreamWriter(String)

Initializes a new instance of the StreamWriter class for the specified file by using the default encoding and buffer size.

System_CAPS_pubmethodStreamWriter(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.

System_CAPS_pubmethodStreamWriter(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.

System_CAPS_pubmethodStreamWriter(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.

NameDescription
System_CAPS_pubpropertyAutoFlush

Gets or sets a value indicating whether the StreamWriter will flush its buffer to the underlying stream after every call to StreamWriter.Write.

System_CAPS_pubpropertyBaseStream

Gets the underlying stream that interfaces with a backing store.

System_CAPS_pubpropertyEncoding

Gets the Encoding in which the output is written.(Overrides TextWriter.Encoding.)

System_CAPS_pubpropertyFormatProvider

Gets an object that controls formatting.(Inherited from TextWriter.)

System_CAPS_pubpropertyNewLine

Gets or sets the line terminator string used by the current TextWriter.(Inherited from TextWriter.)

NameDescription
System_CAPS_pubmethodClose()

Closes the current StreamWriter object and the underlying stream.(Overrides TextWriter.Close().)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the TextWriter object.(Inherited from TextWriter.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the StreamWriter and optionally releases the managed resources.(Overrides TextWriter.Dispose(Boolean).)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFlush()

Clears all buffers for the current writer and causes any buffered data to be written to the underlying stream.(Overrides TextWriter.Flush().)

System_CAPS_pubmethodFlushAsync()

Clears all buffers for this stream asynchronously and causes any buffered data to be written to the underlying device.(Overrides TextWriter.FlushAsync().)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWrite(Boolean)

Writes the text representation of a Boolean value to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWrite(Char)

Writes a character to the stream.(Overrides TextWriter.Write(Char).)

System_CAPS_pubmethodWrite(Char[])

Writes a character array to the stream.(Overrides TextWriter.Write(Char[]).)

System_CAPS_pubmethodWrite(Char[], Int32, Int32)

Writes a subarray of characters to the stream.(Overrides TextWriter.Write(Char[], Int32, Int32).)

System_CAPS_pubmethodWrite(Decimal)

Writes the text representation of a decimal value to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWrite(Double)

Writes the text representation of an 8-byte floating-point value to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWrite(Int32)

Writes the text representation of a 4-byte signed integer to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWrite(Int64)

Writes the text representation of an 8-byte signed integer to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWrite(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.)

System_CAPS_pubmethodWrite(Single)

Writes the text representation of a 4-byte floating-point value to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWrite(String)

Writes a string to the stream.(Overrides TextWriter.Write(String).)

System_CAPS_pubmethodWrite(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.)

System_CAPS_pubmethodWrite(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.)

System_CAPS_pubmethodWrite(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.)

System_CAPS_pubmethodWrite(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.)

System_CAPS_pubmethodWrite(UInt32)

Writes the text representation of a 4-byte unsigned integer to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWrite(UInt64)

Writes the text representation of an 8-byte unsigned integer to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteAsync(Char)

Writes a character to the stream asynchronously.(Overrides TextWriter.WriteAsync(Char).)

System_CAPS_pubmethodWriteAsync(Char[])

Writes a character array to the text string or stream asynchronously.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteAsync(Char[], Int32, Int32)

Writes a subarray of characters to the stream asynchronously.(Overrides TextWriter.WriteAsync(Char[], Int32, Int32).)

System_CAPS_pubmethodWriteAsync(String)

Writes a string to the stream asynchronously.(Overrides TextWriter.WriteAsync(String).)

System_CAPS_pubmethodWriteLine()

Writes a line terminator to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLine(Boolean)

Writes the text representation of a Boolean value followed by a line terminator to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLine(Char)

Writes a character followed by a line terminator to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLine(Char[])

Writes an array of characters followed by a line terminator to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLine(Char[], Int32, Int32)

Writes a subarray of characters followed by a line terminator to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLine(Decimal)

Writes the text representation of a decimal value followed by a line terminator to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(String)

Writes a string followed by a line terminator to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(String, Object, Object, Object)

Writes out a formatted string and a new line, using the same semantics as Format.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLine(String, Object[])

Writes out a formatted string and a new line, using the same semantics as Format.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLineAsync()

Writes a line terminator asynchronously to the stream.(Overrides TextWriter.WriteLineAsync().)

System_CAPS_pubmethodWriteLineAsync(Char)

Writes a character followed by a line terminator asynchronously to the stream.(Overrides TextWriter.WriteLineAsync(Char).)

System_CAPS_pubmethodWriteLineAsync(Char[])

Writes an array of characters followed by a line terminator asynchronously to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLineAsync(Char[], Int32, Int32)

Writes a subarray of characters followed by a line terminator asynchronously to the stream.(Overrides TextWriter.WriteLineAsync(Char[], Int32, Int32).)

System_CAPS_pubmethodWriteLineAsync(String)

Writes a string followed by a line terminator asynchronously to the stream.(Overrides TextWriter.WriteLineAsync(String).)

NameDescription
System_CAPS_protfieldCoreNewLine

Stores the newline characters used for this TextWriter.(Inherited from TextWriter.)

System_CAPS_pubfieldSystem_CAPS_staticNull

Provides a StreamWriter with no backing store that can be written to, but not read from.

System_CAPS_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.

System_CAPS_importantImportant

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.

Universal Windows Platform
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

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

Return to top
Show: