Share via


StreamWriter Constructor (String, Boolean)

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

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.

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

Syntax

'Declaration
Public Sub New ( _
    path As String, _
    append As Boolean _
)
public StreamWriter(
    string path,
    bool append
)
public:
StreamWriter(
    String^ path, 
    bool append
)
new : 
        path:string * 
        append:bool -> StreamWriter
public function StreamWriter(
    path : String, 
    append : boolean
)

Parameters

  • append
    Type: System. . :: . .Boolean
    true to append data to the file; false to overwrite the file. If the specified file does not exist, this parameter has no effect, and the constructor creates a new file.

Remarks

This constructor creates a StreamWriter with UTF-8 encoding 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).

The path parameter can be a file name, including a file on a Universal Naming Convention (UNC) share.

The path parameter is not required to be a file stored on disk; it can be any part of a system that supports access using streams.

Warning

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.

.NET Framework Security

See Also

Reference

StreamWriter Class

StreamWriter Overload

System.IO Namespace