StreamWriter Constructor (Stream, Encoding, Int32, Boolean)

May 11, 2014

Initializes a new instance of the StreamWriter class for the specified stream, using the specified encoding, buffer size, and a value that specifies whether to leave the stream open.

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

public StreamWriter(
	Stream stream,
	Encoding encoding,
	int bufferSize,
	bool leaveOpen
)

Parameters

stream
Type: System.IO.Stream
The stream to write to.
encoding
Type: System.Text.Encoding
The character encoding to use.
bufferSize
Type: System.Int32
The buffer size.
leaveOpen
Type: System.Boolean
true to leave the stream open; otherwise, false.

ExceptionCondition
ArgumentNullException

stream or encoding is null.

ArgumentOutOfRangeException

bufferSize is negative.

ArgumentException

stream is not writable.

This constructor initializes the Encoding property using the encoding parameter, and the BaseStream property using the stream parameter. For additional information, see Encoding.

When leaveOpen is true, the stream is left open after the StreamReader object is disposed. Otherwise, the StreamWriter object calls Dispose on the provided Stream object when StreamWriter.Dispose is called.

Caution noteCaution:

When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable, and could cause an exception to be thrown.

Version Notes

Windows Phone

 If you pass an invalid input path to a StreamWriter constructor, the constructor throws InvalidArgumentException instead of DirectoryNotFoundException.

Windows Phone OS

Supported in: 8.1, 8.0

Show:
© 2014 Microsoft