File.ReadAllBytesAsync(String, CancellationToken) Method

Definition

Namespace:

System.IO

Assembly:

System.Runtime.dll

Source:

File.cs

Asynchronously opens a binary file, reads the contents of the file into a byte array, and then closes the file.

public static System.Threading.Tasks.Task<byte[]> ReadAllBytesAsync (string path, System.Threading.CancellationToken cancellationToken = default);

static member ReadAllBytesAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<byte[]>

Public Shared Function ReadAllBytesAsync (path As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Byte())

Parameters

path

String

The file to open for reading.

cancellationToken

CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task<Byte[]>

A task that represents the asynchronous read operation, which wraps the byte array containing the contents of the file.

Exceptions

OperationCanceledException

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 ReadAllBytes(String).