FileStream.ReadAsync Method (Byte[], Int32, Int32, CancellationToken)

.NET Framework (current version)
 

Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

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

[<ComVisibleAttribute(false)>]
[<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)>]
override ReadAsync : 
        buffer:byte[] *
        offset:int *
        count:int *
        cancellationToken:CancellationToken -> Task<int>

Parameters

buffer
Type: System.Byte[]

The buffer to write the data into.

offset
Type: System.Int32

The byte offset in buffer at which to begin writing data from the stream.

count
Type: System.Int32

The maximum number of bytes to read.

cancellationToken
Type: System.Threading.CancellationToken

The token to monitor for cancellation requests.

Return Value

Type: System.Threading.Tasks.Task<Int32>

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

Exception Condition
ArgumentNullException

buffer is null.

ArgumentOutOfRangeException

offset or count is negative.

ArgumentException

The sum of offset and count is larger than the buffer length.

NotSupportedException

The stream does not support reading.

ObjectDisposedException

The stream has been disposed.

InvalidOperationException

The stream is currently in use by a previous read operation.

The ReadAsync method enables you to perform resource-intensive file operations without blocking the main thread. This performance consideration is particularly important in a Windows 8.x Store app or desktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Use the CanRead property to determine whether the current instance supports reading.

If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property. If the handle to the file is disposed, the returned task contains the ObjectDisposedException exception in the Exception property.

The following example shows how to read from a file asynchronously.

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

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