ReceiveCompletedEventHandler Delegate
Represents the method that will handle the ReceiveCompleted event of a MessageQueue.
Assembly: System.Messaging (in System.Messaging.dll)
'Declaration Public Delegate Sub ReceiveCompletedEventHandler ( _ sender As Object, _ e As ReceiveCompletedEventArgs _ ) 'Usage Dim instance As New ReceiveCompletedEventHandler(AddressOf HandlerMethod)
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
#using <mscorlib.dll>
#using <system.dll>
#using <system.messaging.dll>
using namespace System;
using namespace System::Messaging;
__gc class MyNewQueue
{
//*************************************************
// Provides an event handler for the ReceiveCompleted
// event.
//*************************************************
public:
static void MyReceiveCompleted(Object* source,
ReceiveCompletedEventArgs* asyncResult)
{
// Connect to the queue.
MessageQueue* mq = dynamic_cast<MessageQueue*>(source);
// End the asynchronous Receive operation.
Message* m = mq->EndReceive(asyncResult->AsyncResult);
// Display message information on the screen.
Console::WriteLine(S"Message: {0}", m->Body);
// Restart the asynchronous Receive operation.
mq->BeginReceive();
return;
}
};
//*************************************************
// Provides an entry point into the application.
//
// This example performs asynchronous receive operation
// processing.
//*************************************************
int main()
{
// Create an instance of MessageQueue. Set its formatter.
MessageQueue* myQueue = new MessageQueue(S".\\myQueue");
Type* p __gc[] = new Type* __gc[1];
p[0] = __typeof(String);
myQueue->Formatter = new XmlMessageFormatter( p );
// Add an event handler for the ReceiveCompleted event.
myQueue->ReceiveCompleted += new ReceiveCompletedEventHandler(0, MyNewQueue::MyReceiveCompleted);
// Begin the asynchronous receive operation.
myQueue->BeginReceive();
// Do other work on the current thread.
return 0;
}
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.