Dispatcher::Yield Method (DispatcherPriority)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Creates an awaitable object that asynchronously yields control back to the current dispatcher and provides an opportunity for the dispatcher to process other events. The work that occurs when control returns to the code awaiting the result of this method is scheduled with the specified priority.

Namespace:   System.Windows.Threading
Assembly:  WindowsBase (in WindowsBase.dll)

public:
static DispatcherPriorityAwaitable Yield(
	DispatcherPriority priority
)

Parameters

priority
Type: System.Windows.Threading::DispatcherPriority

The priority at which to schedule the continuation.

Return Value

Type: System.Windows.Threading::DispatcherPriorityAwaitable

An awaitable object that asynchronously yields control back to the current dispatcher and provides an opportunity for the dispatcher to process other events.

This method provides a way for you to temporarily release execution control to the current dispatcher so it can do other work, such as process other events. Use the await, or Await in Visual Basic, operator on the return value to return control to the current dispatcher. Use this method if want to give your app a chance to process events while you app is doing a lot of work on the UI thread. For example, you can use this method in a long-running loop that updates a control.

.NET Framework
Available since 4.5
Return to top
Show: