Windows Dev Center

IAsyncActionWithProgress<TProgress>.Completed property

Gets or sets the method that handles the action completed notification.

Syntax


AsyncActionWithProgressCompletedHandler<TProgress> Completed { get; set; }

Property value

Type: AsyncActionWithProgressCompletedHandler<TProgress>

The method that handles the notification.

Remarks

The Windows Runtime enforces that this property can only be set once on an action.

Generally, a completed IAsyncActionWithProgress<TProgress> method called using language-specific awaitable syntax does nothing further than to return null when it completes.

If you're implementing IAsyncActionWithProgress<TProgress>, then the set implementation of Completed should store the handler, and the surrounding logic should invoke it when Close is called. The implementation should set the asyncStatus parameter of invoked callbacks appropriately if there is a Cancel call, Status is not Completed, errors occurred, and so on.

Requirements (device family)

Device family

Universal

API contract

Windows.Foundation.FoundationContract, introduced version 1.0

Namespace

Windows.Foundation
Windows::Foundation [C++]

Metadata

Windows.Foundation.FoundationContract.winmd

Requirements (operating system)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8

Namespace

Windows.Foundation
Windows::Foundation [C++]

Metadata

Windows.winmd

See also

IAsyncActionWithProgress<TProgress>

 

 

Show:
© 2015 Microsoft