File.WriteAllLines Method (String, String[], Encoding)
Creates a new file, writes the specified string array to the file by using the specified encoding, and then closes the file.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- path
-
Type:
System.String
The file to write to.
- contents
-
Type:
System.String[]
The string array to write to the file.
- encoding
-
Type:
System.Text.Encoding
An Encoding object that represents the character encoding applied to the string array.
| 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 | Either path or contents is null. |
| 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. |
If the target file already exists, it is overwritten.
Given a string array and a file path, this method opens the specified file, writes the string array to the file using the specified encoding, and then closes the file.
The following code example demonstrates the use of the WriteAllLines 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.
using System; using System.IO; using System.Text; class Test { public static void Main() { string path = @"c:\temp\MyTest.txt"; // This text is added only once to the file. if (!File.Exists(path)) { // Create a file to write to. string[] createText = { "Hello", "And", "Welcome" }; File.WriteAllLines(path, createText, Encoding.UTF8); } // This text is always added, making the file longer over time // if it is not deleted. string appendText = "This is extra text" + Environment.NewLine; File.AppendAllText(path, appendText, Encoding.UTF8); // Open the file to read from. string[] readText = File.ReadAllLines(path, Encoding.UTF8); foreach (string s in readText) { Console.WriteLine(s); } } }
for access to write to a file or directory. Associated enumeration: FileIOPermissionAccess.Write
Available since 2.0