Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

File::WriteAllText Method (String^, String^, Encoding^)

 

Creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. If the target file already exists, it is overwritten.

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

public:
static void WriteAllText(
	String^ path,
	String^ contents,
	Encoding^ encoding
)

Parameters

path
Type: System::String^

The file to write to.

contents
Type: System::String^

The string to write to the file.

encoding
Type: System.Text::Encoding^

The encoding to apply to the string.

Exception Condition
ArgumentException

path is a zero-length string, contains only white space, or contains one or more invalid characters as defined by InvalidPathChars.

ArgumentNullException

path is null or contents is empty.

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.

DirectoryNotFoundException

The specified path is invalid (for example, it is on an unmapped drive).

IOException

An I/O error occurred while opening the file.

UnauthorizedAccessException

path specified a file that is read-only.

-or-

This operation is not supported on the current platform.

-or-

path specified a directory.

-or-

The caller does not have the required permission.

NotSupportedException

path is in an invalid format.

SecurityException

The caller does not have the required permission.

Given a string and a file path, this method opens the specified file, writes the string to the file using the specified encoding, and then closes the file. The file handle is guaranteed to be closed by this method, even if exceptions are raised.

The following code example demonstrates the use of the WriteAllText method to write text to a file. In this example a file is created, if it doesn't already exist, and text is added to it.

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

FileIOPermission

for access to write to a file or directory. Associated enumeration: FileIOPermissionAccess::Write

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0
Silverlight
Available since 4.0
Return to top
Show:
© 2017 Microsoft