Export (0) Print
Expand All

AsyncResult.AsyncDelegate Property

Gets the delegate object on which the asynchronous call was invoked.

Namespace:  System.Runtime.Remoting.Messaging
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
Public Overridable ReadOnly Property AsyncDelegate As Object

Property Value

Type: System.Object
The delegate object on which the asynchronous call was invoked.

The AsyncDelegate property can be cast to the actual class of the user-defined delegate.

For example, if the delegate that was used to make the asynchronous call is of type MyDelegate, the delegate that is returned by this property must be cast to MyDelegate. The callback method can then call the delegate's EndInvoke method with the correct signature, in order to obtain the results of the asynchronous method call.

The following code example demonstrates how to use the AsyncDelegate property to get the delegate that was used to make the asynchronous call, in order to call EndInvoke. The example casts the IAsyncResult, which is the only parameter of the callback method, to an AsyncResult object.

The example consists of two classes, the class that contains the method which is called asynchronously, and the class that contains the Main method that makes the call.

For more information on the way this callback example works, and more examples of calling methods asynchronously by using delegates, see Calling Synchronous Methods Asynchronously.

Imports System
Imports System.Threading
Imports System.Runtime.InteropServices 

Namespace Examples.AdvancedProgramming.AsynchronousOperations
    Public Class AsyncDemo 
        ' The method to be executed asynchronously. 
        Public Function TestMethod(ByVal callDuration As Integer, _
                <Out> ByRef threadId As Integer) As String
            Console.WriteLine("Test method begins.")
            Thread.Sleep(callDuration)
            threadId = Thread.CurrentThread.ManagedThreadId()
            return String.Format("My call time was {0}.", callDuration.ToString())
        End Function 
    End Class 

    ' The delegate must have the same signature as the method 
    ' it will call asynchronously. 
    Public Delegate Function AsyncMethodCaller(ByVal callDuration As Integer, _
        <Out> ByRef threadId As Integer) As String 
End Namespace


...


Imports System
Imports System.Threading
Imports System.Runtime.Remoting.Messaging

Namespace Examples.AdvancedProgramming.AsynchronousOperations

    Public Class AsyncMain 

        Shared Sub Main() 

            ' Create an instance of the test class. 
            Dim ad As New AsyncDemo()

            ' Create the delegate. 
            Dim caller As New AsyncMethodCaller(AddressOf ad.TestMethod)

            ' The threadId parameter of TestMethod is an <Out> parameter, so 
            ' its input value is never used by TestMethod. Therefore, a dummy 
            ' variable can be passed to the BeginInvoke call. If the threadId 
            ' parameter were a ByRef parameter, it would have to be a class- 
            ' level field so that it could be passed to both BeginInvoke and  
            ' EndInvoke. 
            Dim dummy As Integer = 0

            ' Initiate the asynchronous call, passing three seconds (3000 ms) 
            ' for the callDuration parameter of TestMethod; a dummy variable  
            ' for the <Out> parameter (threadId); the callback delegate; and 
            ' state information that can be retrieved by the callback method. 
            ' In this case, the state information is a string that can be used 
            ' to format a console message. 
            Dim result As IAsyncResult = caller.BeginInvoke(3000, _
                dummy, _
                AddressOf CallbackMethod, _
                "The call executed on thread {0}, with return value ""{1}"".")

            Console.WriteLine("The main thread {0} continues to execute...", _
                Thread.CurrentThread.ManagedThreadId)

            ' The callback is made on a ThreadPool thread. ThreadPool threads 
            ' are background threads, which do not keep the application running 
            ' if the main thread ends. Comment out the next line to demonstrate 
            ' this.
            Thread.Sleep(4000)

            Console.WriteLine("The main thread ends.")
        End Sub 

        ' The callback method must have the same signature as the 
        ' AsyncCallback delegate. 
        Shared Sub CallbackMethod(ByVal ar As IAsyncResult)
            ' Retrieve the delegate. 
            Dim result As AsyncResult = CType(ar, AsyncResult)
            Dim caller As AsyncMethodCaller = CType(result.AsyncDelegate, AsyncMethodCaller)

            ' Retrieve the format string that was passed as state  
            ' information. 
            Dim formatString As String = CType(ar.AsyncState, String)

            ' Define a variable to receive the value of the <Out> parameter. 
            ' If the parameter were ByRef rather than <Out> then it would have to 
            ' be a class-level field so it could also be passed to BeginInvoke. 
            Dim threadId As Integer = 0

            ' Call EndInvoke to retrieve the results. 
            Dim returnValue As String = caller.EndInvoke(threadId, ar)

            ' Use the format string to format the output message.
            Console.WriteLine(formatString, threadId, returnValue)
        End Sub 
    End Class 
End Namespace 

' This example produces output similar to the following: 

'The main thread 1 continues to execute... 
'Test method begins. 
'The call executed on thread 3, with return value "My call time was 3000.". 
'The main thread ends.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft