Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

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
)

Parameters

sender
Type: System.Object

The source of the event, the MessageQueue.

e
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 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;
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[]
				{typeof(String)});

			// Add an event handler for the PeekCompleted event.
			myQueue.PeekCompleted += new 
				PeekCompletedEventHandler(MyPeekCompleted);
			
			// Begin the asynchronous peek operation.
			myQueue.BeginPeek();
			
			// Do other work on the current thread. 

			return;
		}


		//************************************************** 
		// 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.
			mq.BeginPeek();
			
			return; 
		}
	}
}

.NET Framework

Supported in: 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 Phone 8.1, Windows Phone 8, 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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.