MessageQueue::EndPeek Method (IAsyncResult^)


Completes the specified asynchronous peek operation.

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

Message^ EndPeek(
	IAsyncResult^ asyncResult


Type: System::IAsyncResult^

The IAsyncResult that identifies the asynchronous peek operation to finish and from which to retrieve an end result.

Return Value

Type: System.Messaging::Message^

The Message associated with the completed asynchronous operation.

Exception Condition

The asyncResult parameter is null.


The syntax of the asyncResult parameter is not valid.


An error occurred when accessing a Message Queuing method.

When the PeekCompleted event is raised, EndPeek(IAsyncResult^) completes the operation that was initiated by the BeginPeek call. To do so, EndPeek(IAsyncResult^) peeks the message.

BeginPeek can specify a time-out, which causes the PeekCompleted event to be raised if the time-out occurs before a message appears in the queue. When a time-out occurs without a message arriving in the queue, a subsequent call to EndPeek(IAsyncResult^) throws an exception.

EndPeek(IAsyncResult^) is used to read the message that caused the PeekCompleted event to be raised.

If you want to continue to asynchronously peek messages, you can again call BeginPeek after calling EndPeek(IAsyncResult^).

The following table shows whether this method is available in various Workgroup modes.

Workgroup mode


Local computer


Local computer and direct format name


Remote computer


Remote computer and direct format name


The following code example creates an event handler named MyPeekCompleted, attaches it to the PeekCompleted event handler delegate, and calls BeginPeek to initiate an asynchronous peek operation on the queue that is located at the path ".\myQueue". When a PeekCompleted event is raised, the example peeks the message and writes its body to the screen. The example then calls BeginPeek again to initiate a new asynchronous peek operation.

#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