This documentation is archived and is not being maintained.

PeekCompletedEventArgs Class

Provides data for the PeekCompleted event. When your asynchronous peek operation calls an event handler, an instance of this class is passed to the handler.


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

public class PeekCompletedEventArgs : EventArgs

The PeekCompletedEventArgs type exposes the following members.

Public propertyAsyncResultGets or sets the result of the asynchronous operation requested.
Public propertyMessageGets the message associated with the asynchronous peek operation.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

When you use event notification to peek (read without removing) messages asynchronously from the queue, you must create a method that handles your message processing. Your code must call BeginPeek to begin the asynchronous processing. When a message is peeked, your application is notified through the PeekCompleted event. An instance of PeekCompletedEventArgs is passed into the event delegate that calls your event handler. The data associated with the PeekCompleted event is contained in the delegate's AsyncResult parameter.

There are two ways to provide notification of event completion: event notification and callbacks. PeekCompletedEventArgs is used only with event notification. For information comparing callbacks and event notification, see "Events vs. Callbacks" on MSDN.

PeekCompletedEventArgs provides access to the message that initiated the end of the asynchronous peek operation, through the Message member. This is an alternate access to the message, and behaves much the same as a call to MessageQueue.EndPeek.

The following code example creates an event handler for the PeekCompleted event and associates it with the event delegate by using the PeekCompletedEventHandler. The event handler, MyPeekCompleted, peeks a message and writes its label to the screen.

using System;
using System.Messaging;

namespace MyProject
	/// <summary>
	/// Provides a container class for the example.
	/// </summary>
	public class MyNewQueue

		// Provides an entry point into the application.
		// This example performs asynchronous peek operation
		// processing.

		public static void Main()
			// Create an instance of MessageQueue. Set its formatter.
			MessageQueue myQueue = new MessageQueue(".\\myQueue");
			myQueue.Formatter = new XmlMessageFormatter(new Type[]

			// Add an event handler for the PeekCompleted event.
			myQueue.PeekCompleted += new 
			// Begin the asynchronous peek operation.
			// Do other work on the current thread.


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

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

			// Display message information on the screen.
			Console.WriteLine("Message: " + (string)m.Body);

			// Restart the asynchronous peek operation.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.