TaskExtensions.DispatcherOperationWait Method (Task, TimeSpan)

.NET Framework 4.6 and 4.5

Waits for the specified amount of time for the underlying DispatcherOperation to complete.

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

static member DispatcherOperationWait : 
        this:Task * 
        timeout:TimeSpan -> DispatcherOperationStatus

Parameters

this
Type: System.Threading.Tasks.Task

The Task that is associated with the DispatcherOperation.

timeout
Type: System.TimeSpan

The amount of time to wait.

Return Value

Type: System.Windows.Threading.DispatcherOperationStatus
The status of the underlying DispatcherOperation.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Task. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

ExceptionCondition
NotSupportedException

The Task is not associated with a DispatcherOperation.

Call the IsDispatcherOperationTask method to check whether the Task is associated with a DispatcherOperation before you call this method.

.NET Framework

Supported in: 4.6, 4.5
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft