File.WriteAllLines Method (String, IEnumerable(Of String), Encoding)

 

Creates a new file by using the specified encoding, writes a collection of strings to the file, and then closes the file.

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

Public Shared Sub WriteAllLines (
	path As String,
	contents As IEnumerable(Of String),
	encoding As Encoding
)

Parameters

path
Type: System.String

The file to write to.

contents
Type: System.Collections.Generic.IEnumerable(Of String)

The lines to write to the file.

encoding
Type: System.Text.Encoding

The character encoding to use.

Exception Condition
ArgumentException

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

ArgumentNullException

Either path, contents, or encoding is null.

DirectoryNotFoundException

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

IOException

An I/O error occurred while opening the file.

PathTooLongException

path exceeds 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.

NotSupportedException

path is in an invalid format.

SecurityException

The caller does not have the required permission.

UnauthorizedAccessException

path specifies a file that is read-only.

-or-

This operation is not supported on the current platform.

-or-

path is a directory.

-or-

The caller does not have the required permission.

If the target file already exists, it is overwritten.

You can use this method to create a file that contains the following:

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