PeekCompletedEventHandler Delegate


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

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

public delegate void PeekCompletedEventHandler(
	Object^ sender,
	PeekCompletedEventArgs^ e


Type: System::Object^

The source of the event, the MessageQueue.

Type: System.Messaging::PeekCompletedEventArgs^

A PeekCompletedEventArgs that contains the event data.

When you create a PeekCompletedEventHandler 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 NIB: Events and Delegates.

The following example illustrates how to create an event delegate (PeekCompletedEventHandler) for the event handler (MyPeekCompleted) and associate it with the MessageQueue::PeekCompleted event. The event handler peeks a message and writes its label to the screen.

#using <system.dll>
#using <system.messaging.dll>

using namespace System;
using namespace System::Messaging;

// This example performs asynchronous peek operation
// processing.
ref class MyNewQueue

   // Provides an event handler for the PeekCompleted
   // event.
   static void MyPeekCompleted( Object^ source, PeekCompletedEventArgs^ asyncResult )
      // Connect to the queue.
      MessageQueue^ mq = dynamic_cast<MessageQueue^>(source);

      // End the asynchronous peek operation.
      Message^ m = mq->EndPeek( asyncResult->AsyncResult );

      // Display message information on the screen.
      Console::WriteLine( "Message: {0}", static_cast<String^>(m->Body) );

      // Restart the asynchronous peek operation.

// Provides an entry point into the application.
int main()
   // Create an instance of MessageQueue. Set its formatter.
   MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );
   array<Type^>^p = gcnew array<Type^>(1);
   p[ 0 ] = String::typeid;
   myQueue->Formatter = gcnew XmlMessageFormatter( p );

   // Add an event handler for the PeekCompleted event.
   myQueue->PeekCompleted += gcnew PeekCompletedEventHandler( MyNewQueue::MyPeekCompleted );

   // Begin the asynchronous peek operation.

   // Do other work on the current thread.
   return 0;

.NET Framework
Available since 1.1
Return to top