File.WriteAllTextAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| WriteAllTextAsync(String, ReadOnlyMemory<Char>, Encoding, CancellationToken) |
Asynchronously 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 truncated and overwritten. |
| WriteAllTextAsync(String, ReadOnlyMemory<Char>, CancellationToken) |
Asynchronously creates a new file, writes the specified string to the file, and then closes the file. If the target file already exists, it is truncated and overwritten. |
| WriteAllTextAsync(String, String, CancellationToken) |
Asynchronously creates a new file, writes the specified string to the file, and then closes the file. If the target file already exists, it is truncated and overwritten. |
| WriteAllTextAsync(String, String, Encoding, CancellationToken) |
Asynchronously 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 truncated and overwritten. |
WriteAllTextAsync(String, ReadOnlyMemory<Char>, Encoding, CancellationToken)
Asynchronously 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 truncated and overwritten.
public static System.Threading.Tasks.Task WriteAllTextAsync (string path, ReadOnlyMemory<char> contents, System.Text.Encoding encoding, System.Threading.CancellationToken cancellationToken = default);static member WriteAllTextAsync : string * ReadOnlyMemory<char> * System.Text.Encoding * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Shared Function WriteAllTextAsync (path As String, contents As ReadOnlyMemory(Of Char), encoding As Encoding, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- path
- String
The file to write to.
- contents
- ReadOnlyMemory<Char>
The characters to write to the file.
- encoding
- Encoding
The encoding to apply to the string.
- cancellationToken
- CancellationToken
The token to monitor for cancellation requests. The default value is None.
Returns
A task that represents the asynchronous write operation.
Exceptions
The cancellation token was canceled. This exception is stored into the returned task.
Applies to
WriteAllTextAsync(String, ReadOnlyMemory<Char>, CancellationToken)
Asynchronously creates a new file, writes the specified string to the file, and then closes the file.
If the target file already exists, it is truncated and overwritten.
public static System.Threading.Tasks.Task WriteAllTextAsync (string path, ReadOnlyMemory<char> contents, System.Threading.CancellationToken cancellationToken = default);static member WriteAllTextAsync : string * ReadOnlyMemory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Shared Function WriteAllTextAsync (path As String, contents As ReadOnlyMemory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- path
- String
The file to write to.
- contents
- ReadOnlyMemory<Char>
The characters to write to the file.
- cancellationToken
- CancellationToken
The token to monitor for cancellation requests. The default value is None.
Returns
A task that represents the asynchronous write operation.
Exceptions
The cancellation token was canceled. This exception is stored into the returned task.
Applies to
WriteAllTextAsync(String, String, CancellationToken)
- Source:
- File.cs
- Source:
- File.cs
- Source:
- File.cs
Asynchronously creates a new file, writes the specified string to the file, and then closes the file. If the target file already exists, it is truncated and overwritten.
public static System.Threading.Tasks.Task WriteAllTextAsync (string path, string? contents, System.Threading.CancellationToken cancellationToken = default);public static System.Threading.Tasks.Task WriteAllTextAsync (string path, string contents, System.Threading.CancellationToken cancellationToken = default);static member WriteAllTextAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Shared Function WriteAllTextAsync (path As String, contents As String, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- path
- String
The file to write to.
- contents
- String
The string to write to the file.
- cancellationToken
- CancellationToken
The token to monitor for cancellation requests. The default value is None.
Returns
A task that represents the asynchronous write operation.
Exceptions
The cancellation token was canceled. This exception is stored into the returned task.
Remarks
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by WriteAllText(String, String).
Applies to
WriteAllTextAsync(String, String, Encoding, CancellationToken)
- Source:
- File.cs
- Source:
- File.cs
- Source:
- File.cs
Asynchronously 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 truncated and overwritten.
public static System.Threading.Tasks.Task WriteAllTextAsync (string path, string? contents, System.Text.Encoding encoding, System.Threading.CancellationToken cancellationToken = default);public static System.Threading.Tasks.Task WriteAllTextAsync (string path, string contents, System.Text.Encoding encoding, System.Threading.CancellationToken cancellationToken = default);static member WriteAllTextAsync : string * string * System.Text.Encoding * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Shared Function WriteAllTextAsync (path As String, contents As String, encoding As Encoding, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- path
- String
The file to write to.
- contents
- String
The string to write to the file.
- encoding
- Encoding
The encoding to apply to the string.
- cancellationToken
- CancellationToken
The token to monitor for cancellation requests. The default value is None.
Returns
A task that represents the asynchronous write operation.
Exceptions
The cancellation token was canceled. This exception is stored into the returned task.
Remarks
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by WriteAllText(String, String, Encoding).
