AsyncOperation.PostOperationCompleted(SendOrPostCallback, Object) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Ends the lifetime of an asynchronous operation.
public:
void PostOperationCompleted(System::Threading::SendOrPostCallback ^ d, System::Object ^ arg);public void PostOperationCompleted (System.Threading.SendOrPostCallback d, object arg);public void PostOperationCompleted (System.Threading.SendOrPostCallback d, object? arg);member this.PostOperationCompleted : System.Threading.SendOrPostCallback * obj -> unitPublic Sub PostOperationCompleted (d As SendOrPostCallback, arg As Object)Parameters
A SendOrPostCallback object that wraps the delegate to be called when the operation ends.
- arg
- Object
An argument for the delegate contained in the d parameter.
Exceptions
OperationCompleted() has been called previously for this task.
d is null.
Examples
The following code example demonstrates using the PostOperationCompleted method to end the lifetime of an asynchronous operation. This code example is part of a larger example provided for the System.ComponentModel.AsyncOperationManager class.
// This method cancels a pending asynchronous operation.
public void CancelAsync(object taskId)
{
AsyncOperation asyncOp = userStateToLifetime[taskId] as AsyncOperation;
if (asyncOp != null)
{
lock (userStateToLifetime.SyncRoot)
{
userStateToLifetime.Remove(taskId);
}
}
}
' This method cancels a pending asynchronous operation.
Public Sub CancelAsync(ByVal taskId As Object)
Dim obj As Object = userStateToLifetime(taskId)
If (obj IsNot Nothing) Then
SyncLock userStateToLifetime.SyncRoot
userStateToLifetime.Remove(taskId)
End SyncLock
End If
End Sub
Remarks
Call the PostOperationCompleted method to end the lifetime of an asynchronous operation. After this method is called for a particular task, calls to its corresponding AsyncOperation object will raise an exception.
The d parameter wraps the delegate you want your class to call when the task's lifetime ends due to completion, cancellation, or failure of the task. The AsyncOperation object will ensure that your delegate is invoked on the thread or context appropriate for the application model. Your delegate can optionally raise an event that notifies clients that the asynchronous task's lifetime has ended.
The arg parameter is used to pass state information to the completion delegate d. You can use an AsyncOperation object, or an System.ComponentModel.AsyncCompletedEventArgs object as the parameter value. Alternatively, if you want to provide additional state storage, you can use an instance of a class you derive from the System.ComponentModel.AsyncCompletedEventArgs class.
Notes to Inheritors
Inheritors must make the PostOperationCompleted(SendOrPostCallback, Object) invocation asynchronous, so that class library providers do not need to concern themselves with potential stack overflows if they assume asynchrony but a particular application model happens to be synchronous. The method should be interpreted as an "ending the lifetime" call, meaning the implementation needs to do what is appropriate for the application model. For instance, ASP.NET will decrement its count of outstanding asynchronous operations. This also should put the operation into a state such that any subsequent calls into it will fail, since it has now completed.
For more information about implementing asynchronous classes, see Implementing the Event-based Asynchronous Pattern.
