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

 

Asynchronously reads the specified number of bytes into the specified array.

Available starting in .NET Framework 4.6

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

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

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. The default value is None.

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.

If an exception occurs during the read operation, it will be set as the Task.Exception of the property of the returned task.

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