Skip to main content

Windows Dev Center

FileRandomAccessStream.ReadAsync | readAsync method

Returns an asynchronous byte reader object.

Syntax


fileRandomAccessStream.readAsync(buffer, count, options).done( /* Your success and error handlers */ );

public IAsyncOperationWithProgress<IBuffer, UInt32> ReadAsync(
  IBuffer buffer, 
  uint count, 
  InputStreamOptions options
)

Public Function ReadAsync(
  buffer As IBuffer,  
  count As UInteger,  
  options As InputStreamOptions 
) As IAsyncOperationWithProgress(Of IBuffer, UInt32)

public:
IAsyncOperationWithProgress<IBuffer, UInt32>^ ReadAsync(
  IBuffer^ buffer, 
  unsigned int count, 
  InputStreamOptions options
)

Parameters

buffer

Type: IBuffer

The buffer into which the asynchronous read operation places the bytes that are read.

count

Type: Number [JavaScript] | System.UInt32 [.NET] | uint32 [C++]

The number of bytes to read that is less than or equal to the Capacity value.

options

Type: InputStreamOptions

Specifies the type of the asynchronous read operation.

Return value

Type: IAsyncOperationWithProgress<IBuffer, UInt32>

The asynchronous operation.

Requirements ( device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.Storage.Streams
Windows::Storage::Streams [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (operating system)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8

Namespace

Windows.Storage.Streams
Windows::Storage::Streams [C++]

Metadata

Windows.winmd

See also

FileRandomAccessStream