StreamWriter Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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

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

public class StreamWriter : TextWriter

The StreamWriter type exposes the following members.

  NameDescription
Public methodStreamWriter(Stream)Initializes a new instance of the StreamWriter class for the specified stream by using UTF-8 encoding and the default buffer size.
Public methodStreamWriter(String)Initializes a new instance of the StreamWriter class for the specified file by using the default encoding and buffer size.
Public methodStreamWriter(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.
Top

  NameDescription
Public propertyBaseStreamGets the underlying stream that interfaces with a backing store.
Public propertyEncodingGets the Encoding in which the output is written. (Overrides TextWriter..::..Encoding.)
Public propertyNewLineGets or sets the line terminator string used by the current TextWriter. (Inherited from TextWriter.)
Top

  NameDescription
Public methodCloseCloses the current StreamWriter object and the underlying stream. (Overrides TextWriter..::..Close()()()().)
Public methodDispose()()()()Releases all resources used by the TextWriter object. (Inherited from TextWriter.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the StreamWriter and optionally releases the managed resources. (Overrides TextWriter..::..Dispose(Boolean).)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFlushClears all buffers for the current writer and causes any buffered data to be written to the underlying stream. (Overrides TextWriter..::..Flush()()()().)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWrite(Boolean)Writes the text representation of a Boolean value to the text string or stream. (Inherited from TextWriter.)
Public methodWrite(Char)Writes a character to the stream. (Overrides TextWriter..::..Write(Char).)
Public methodWrite(array<Char>[]()[][])Writes a character array to the text string or stream. (Inherited from TextWriter.)
Public methodWrite(Double)Writes the text representation of an 8-byte floating-point value to the text string or stream. (Inherited from TextWriter.)
Public methodWrite(Int32)Writes the text representation of a 4-byte signed integer to the text string or stream. (Inherited from TextWriter.)
Public methodWrite(Int64)Writes the text representation of an 8-byte signed integer to the text string or stream. (Inherited from TextWriter.)
Public methodWrite(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 methodWrite(Single)Writes the text representation of a 4-byte floating-point value to the text string or stream. (Inherited from TextWriter.)
Public methodWrite(String)Writes a string to the text string or stream. (Inherited from TextWriter.)
Public methodWrite(UInt32)Writes the text representation of a 4-byte unsigned integer to the text string or stream. (Inherited from TextWriter.)
Public methodWrite(UInt64)Writes the text representation of an 8-byte unsigned integer to the text string or stream. (Inherited from TextWriter.)
Public methodWrite(array<Char>[]()[][], Int32, Int32)Writes a subarray of characters to the text string or stream. (Inherited from TextWriter.)
Public methodWriteLine()()()()Writes a line to the stream. (Overrides TextWriter..::..WriteLine()()()().)
Public methodWriteLine(Boolean)Writes the text representation of a Boolean value followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodWriteLine(Char)Writes a character followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodWriteLine(array<Char>[]()[][])Writes an array of characters followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Public methodWriteLine(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 methodWriteLine(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 methodWriteLine(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 methodWriteLine(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 methodWriteLine(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 methodWriteLine(String)Writes a string followed by a line terminator to the text stream. (Overrides TextWriter..::..WriteLine(String).)
Public methodWriteLine(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 methodWriteLine(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 methodWriteLine(array<Char>[]()[][], Int32, Int32)Writes a subarray of characters followed by a line terminator to the text string or stream. (Inherited from TextWriter.)
Top

  NameDescription
Protected fieldCoreNewLineStores the newline characters used for this TextWriter. (Inherited from TextWriter.)
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. 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 #ctor(String, Boolean, Encoding) or #ctor.

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: