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.
Inheritance Hierarchy
System. . :: . .Object
System. . :: . .MarshalByRefObject
System.IO. . :: . .TextWriter
System.IO..::..StreamWriter
Namespace: System.IO
Assembly: System.IO (in System.IO.dll)
Syntax
'Declaration
Public Class StreamWriter _
Inherits TextWriter
public class StreamWriter : TextWriter
public ref class StreamWriter : public TextWriter
type StreamWriter =
class
inherit TextWriter
end
public class StreamWriter extends TextWriter
The StreamWriter type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
StreamWriter(Stream) | Initializes a new instance of the StreamWriter class for the specified stream by using UTF-8 encoding and the default buffer size. |
|
StreamWriter(String) | Initializes a new instance of the StreamWriter class for the specified file by using the default encoding and buffer size. |
|
StreamWriter(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
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
BaseStream | Gets the underlying stream that interfaces with a backing store. |
|
Encoding | Gets the Encoding in which the output is written. (Overrides TextWriter. . :: . .Encoding.) |
|
NewLine | Gets or sets the line terminator string used by the current TextWriter. (Inherited from TextWriter.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Close | Closes the current StreamWriter object and the underlying stream. (Overrides TextWriter. . :: . .Close() () () ().) |
|
Dispose() () () () | Releases all resources used by the TextWriter object. (Inherited from TextWriter.) |
.gif "Protected method") |
Dispose(Boolean) | Releases the unmanaged resources used by the StreamWriter and optionally releases the managed resources. (Overrides TextWriter. . :: . .Dispose(Boolean).) |
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
Flush | Clears all buffers for the current writer and causes any buffered data to be written to the underlying stream. (Overrides TextWriter. . :: . .Flush() () () ().) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
Write(Boolean) | Writes the text representation of a Boolean value to the text string or stream. (Inherited from TextWriter.) |
|
Write(Char) | Writes a character to the stream. (Overrides TextWriter. . :: . .Write(Char).) |
|
Write(array<Char> [] () [] []) | Writes a character array to the text string or stream. (Inherited from TextWriter.) |
|
Write(Double) | Writes the text representation of an 8-byte floating-point value to the text string or stream. (Inherited from TextWriter.) |
|
Write(Int32) | Writes the text representation of a 4-byte signed integer to the text string or stream. (Inherited from TextWriter.) |
|
Write(Int64) | Writes the text representation of an 8-byte signed integer to the text string or stream. (Inherited from TextWriter.) |
|
Write(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.) |
|
Write(Single) | Writes the text representation of a 4-byte floating-point value to the text string or stream. (Inherited from TextWriter.) |
|
Write(String) | Writes a string to the text string or stream. (Inherited from TextWriter.) |
|
Write(UInt32) | Writes the text representation of a 4-byte unsigned integer to the text string or stream. (Inherited from TextWriter.) |
|
Write(UInt64) | Writes the text representation of an 8-byte unsigned integer to the text string or stream. (Inherited from TextWriter.) |
|
Write(array<Char> [] () [] [], Int32, Int32) | Writes a subarray of characters to the text string or stream. (Inherited from TextWriter.) |
|
WriteLine() () () () | Writes a line to the stream. (Overrides TextWriter. . :: . .WriteLine() () () ().) |
|
WriteLine(Boolean) | Writes the text representation of a Boolean value followed by a line terminator to the text string or stream. (Inherited from TextWriter.) |
|
WriteLine(Char) | Writes a character followed by a line terminator to the text string or stream. (Inherited from TextWriter.) |
|
WriteLine(array<Char> [] () [] []) | Writes an array of characters followed by a line terminator to the text string or stream. (Inherited from TextWriter.) |
|
WriteLine(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.) |
|
WriteLine(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.) |
|
WriteLine(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.) |
|
WriteLine(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.) |
|
WriteLine(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.) |
|
WriteLine(String) | Writes a string followed by a line terminator to the text stream. (Overrides TextWriter. . :: . .WriteLine(String).) |
|
WriteLine(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.) |
|
WriteLine(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.) |
|
WriteLine(array<Char> [] () [] [], Int32, Int32) | Writes a subarray of characters followed by a line terminator to the text string or stream. (Inherited from TextWriter.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Protected field") |
CoreNewLine | Stores the newline characters used for this TextWriter. (Inherited from TextWriter.) |
Top
Remarks
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.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.