DataReaderLoadOperation DataReaderLoadOperation DataReaderLoadOperation DataReaderLoadOperation Class

Definition

Loads data from an input stream.

public : sealed class DataReaderLoadOperation : IAsyncInfo, IAsyncOperation<unsigned int>
public sealed class DataReaderLoadOperation : IAsyncInfo, IAsyncOperation<UInt32>
Public NotInheritable Class DataReaderLoadOperation Implements IAsyncInfo, IAsyncOperation<UInt32>
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

Completed Completed Completed Completed

Gets or sets the handler to call when the data load operation is complete.

public : AsyncOperationCompletedHandler<unsigned int> Completed { get; set; }
public AsyncOperationCompletedHandler<uint> Completed { get; set; }
Public ReadWrite Property Completed As AsyncOperationCompletedHandler<uint>
var asyncOperationCompletedHandler = dataReaderLoadOperation.completed;
dataReaderLoadOperation.completed = asyncOperationCompletedHandler;
Value
AsyncOperationCompletedHandler<unsigned int> AsyncOperationCompletedHandler<uint> AsyncOperationCompletedHandler<uint> AsyncOperationCompletedHandler<uint>

The handler to call when the operation is complete.

ErrorCode ErrorCode ErrorCode ErrorCode

Gets the error code for the data load operation if it fails.

public : HResult ErrorCode { get; }
public Exception ErrorCode { get; }
Public ReadOnly Property ErrorCode As Exception
var exception = dataReaderLoadOperation.errorCode;
Value
HResult Exception Exception Exception

The status of the operation.

Id Id Id Id

Gets a unique identifier that represents the data load operation.

public : unsigned int Id { get; }
public uint Id { get; }
Public ReadOnly Property Id As uint
var uint = dataReaderLoadOperation.id;
Value
unsigned int uint uint uint

The identifier.

Status Status Status Status

Gets the current status of the data load operation.

public : AsyncStatus Status { get; }
public AsyncStatus Status { get; }
Public ReadOnly Property Status As AsyncStatus
var asyncStatus = dataReaderLoadOperation.status;
Value
AsyncStatus AsyncStatus AsyncStatus AsyncStatus

One of the enumeration values.

Methods

Cancel() Cancel() Cancel() Cancel()

Requests the cancellation of the data load operation.

public : void Cancel()
public void Cancel()
Public Function Cancel() As void
dataReaderLoadOperation.cancel();

Close() Close() Close() Close()

Requests that work associated with the data load operation should stop.

public : void Close()
public void Close()
Public Function Close() As void
dataReaderLoadOperation.close();

GetResults() GetResults() GetResults() GetResults()

Returns the result of the data load operation.

public : unsigned int GetResults()
public uint GetResults()
Public Function GetResults() As uint
var uint = dataReaderLoadOperation.getResults();
Returns
unsigned int uint uint uint

The number of bytes read by the DataReader.