Expand Minimize

ReceiveCompletedEventHandler Delegate

Represents the method that will handle the ReceiveCompleted event of a MessageQueue.

Namespace:  System.Messaging
Assembly:  System.Messaging (in System.Messaging.dll)

'Declaration
Public Delegate Sub ReceiveCompletedEventHandler ( _
	sender As Object, _
	e As ReceiveCompletedEventArgs _
)

Parameters

sender
Type: System.Object

The source of the event, the MessageQueue.

e
Type: System.Messaging.ReceiveCompletedEventArgs

A ReceiveCompletedEventArgs that contains the event data.

When you create a ReceiveCompletedEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see Events and Delegates.

The following code example illustrates how to create an event delegate (ReceiveCompletedEventHandler) for the event handler (MyReceiveCompleted) and associate it with the MessageQueue.ReceiveCompleted event. The event handler receives a message from a queue, and writes its label to the screen.

Imports System
Imports System.Messaging

Public Class MyNewQueue


        
        ' Provides an entry point into the application. 
        '		  
        ' This example performs asynchronous receive operation 
        ' processing. 
        

        Public Shared Sub Main()

            ' Create an instance of MessageQueue. Set its formatter. 
            Dim myQueue As New MessageQueue(".\myQueue")
            myQueue.Formatter = New XmlMessageFormatter(New Type() _
                {GetType([String])})

            ' Add an event handler for the ReceiveCompleted event. 
            AddHandler myQueue.ReceiveCompleted, AddressOf _
                MyReceiveCompleted

            ' Begin the asynchronous receive operation.
            myQueue.BeginReceive()

            ' Do other work on the current thread. 

            Return 

        End Sub 'Main


        
        ' Provides an event handler for the ReceiveCompleted 
        ' event. 
        

        Private Shared Sub MyReceiveCompleted(ByVal [source] As _
            [Object], ByVal asyncResult As ReceiveCompletedEventArgs)

            ' Connect to the queue. 
            Dim mq As MessageQueue = CType([source], MessageQueue)

            ' End the asynchronous Receive operation. 
            Dim m As Message = mq.EndReceive(asyncResult.AsyncResult)

            ' Display message information on the screen.
            Console.WriteLine(("Message: " + CStr(m.Body)))

            ' Restart the asynchronous Receive operation.
            mq.BeginReceive()

            Return 

        End Sub 'MyReceiveCompleted

End Class 'MyNewQueue

.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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft