Export (0) Print
Expand All

StreamWriter Constructor (Stream, Encoding, Int32, Boolean)

.NET Framework 4.5

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.

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

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.

The following example demonstrates this constructor.

using System;
using System.IO;
using System.Text;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            string fileName = "test.txt";
            string textToAdd = "Example text in file";

            using (FileStream fs = new FileStream(fileName, FileMode.CreateNew))
            {
                using (StreamWriter writer = new StreamWriter(fs, Encoding.UTF8, 512, false))
                {
                    writer.Write(textToAdd);
                }
            }
        }
    }
}

.NET Framework

Supported in: 4.5

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft