StreamWriter Constructor (String, Boolean, Encoding)
Initializes a new instance of the StreamWriter class for the specified file on the specified path, using the specified encoding and default 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.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- path
- Type: System::String
The complete file path to write to.
- append
- Type: System::Boolean
Determines whether data is to be appended to the file. If the file exists and append is false, the file is overwritten. If the file exists and append is true, the data is appended to the file. Otherwise, a new file is created.
- encoding
- Type: System.Text::Encoding
The character encoding to use.
| Exception | Condition |
|---|---|
| UnauthorizedAccessException | Access is denied. |
| ArgumentException | path is empty. -or- path contains the name of a system device (com1, com2, and so on). |
| ArgumentNullException | path is nullptr. |
| DirectoryNotFoundException | The specified path is invalid, such as being on an unmapped drive. |
| IOException | path includes an incorrect or invalid syntax for file name, directory name, or volume label syntax. |
| PathTooLongException | The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters. |
| SecurityException | The caller does not have the required permission. |
This constructor initializes the Encoding property using the encoding parameter. For additional information, see Encoding.
path can be a file name, including a file on a Universal Naming Convention (UNC) share.
path is not required to be a file stored on disk; it can be any part of a system that supports access via streams.
Caution |
|---|
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. |
For a list of common I/O tasks, see Common I/O Tasks.
The following example demonstrates the StreamWriter constructors.
void CreateTextFile( String^ fileName, String^ textToAdd ) { String^ logFile = String::Concat( DateTime::Now.ToShortDateString() ->Replace( "/", "-" )->Replace( "\\", "-" ), ".log" ); FileStream^ fs = gcnew FileStream( fileName, FileMode::CreateNew, FileAccess::Write, FileShare::None ); StreamWriter^ swFromFile = gcnew StreamWriter( logFile ); swFromFile->Write( textToAdd ); swFromFile->Flush(); swFromFile->Close(); StreamWriter^ swFromFileStream = gcnew StreamWriter( fs ); swFromFileStream->Write( textToAdd ); swFromFileStream->Flush(); swFromFileStream->Close(); StreamWriter^ swFromFileStreamDefaultEnc = gcnew System::IO::StreamWriter( fs, System::Text::Encoding::Default ); swFromFileStreamDefaultEnc->Write( textToAdd ); swFromFileStreamDefaultEnc->Flush(); swFromFileStreamDefaultEnc->Close(); StreamWriter^ swFromFileTrue = gcnew StreamWriter( fileName,true ); swFromFileTrue->Write( textToAdd ); swFromFileTrue->Flush(); swFromFileTrue->Close(); StreamWriter^ swFromFileTrueUTF8Buffer = gcnew StreamWriter( fileName, true, System::Text::Encoding::UTF8, 512 ); swFromFileTrueUTF8Buffer->Write( textToAdd ); swFromFileTrueUTF8Buffer->Flush(); swFromFileTrueUTF8Buffer->Close(); StreamWriter^ swFromFileTrueUTF8 = gcnew StreamWriter( fileName, true, System::Text::Encoding::UTF8 ); swFromFileTrueUTF8->Write( textToAdd ); swFromFileTrueUTF8->Flush(); swFromFileTrueUTF8->Close(); StreamWriter^ swFromFileStreamUTF8Buffer = gcnew StreamWriter( fs, System::Text::Encoding::UTF8, 512 ); swFromFileStreamUTF8Buffer->Write( textToAdd ); swFromFileStreamUTF8Buffer->Flush(); swFromFileStreamUTF8Buffer->Close(); }
- FileIOPermission
for reading and writing files. Associated enumeration: FileIOPermissionAccess::Read, FileIOPermissionAccess::Write
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Caution