StreamWriter Constructor (Stream^, Encoding^, Int32, Boolean)

.NET Framework (current version)
 

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.

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, in bytes.

leaveOpen
Type: System::Boolean

true to leave the stream open after the StreamWriter object is disposed; otherwise, false.

Exception Condition
ArgumentNullException

stream or encoding is null.

ArgumentOutOfRangeException

bufferSize is negative.

ArgumentException

stream is not writable.

Unless you set the leaveOpen parameter to true, the StreamWriter object calls Dispose() on the provided Stream object when StreamWriter::Dispose is called.

This constructor initializes the Encoding property by using the encoding parameter, and initializes the BaseStream property by using the stream parameter. The position of the stream is not reset. For additional information, see the Encoding property.

System_CAPS_cautionCaution

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.

The following example demonstrates this constructor.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show: