MessageQueue.MessageReadPropertyFilter Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the property filter for receiving or peeking messages.

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

[BrowsableAttribute(false)]
[MessagingDescriptionAttribute("MQ_MessageReadPropertyFilter")]
public MessagePropertyFilter MessageReadPropertyFilter { get; set; }

Property Value

Type: System.Messaging.MessagePropertyFilter

The MessagePropertyFilter used by the queue to filter the set of properties it receives or peeks for each message.

Exception Condition
ArgumentException

The filter is null.

This filter is a set of Boolean values restricting the message properties that the MessageQueue receives or peeks. When the MessageQueue receives or peeks a message from the server queue, it retrieves only those properties for which the MessageReadPropertyFilter value is true.

The following shows initial property values for the MessageReadPropertyFilter property. These settings are identical to calling SetDefaults on a MessagePropertyFilter.

Property

Default value

Acknowledgment

false

AcknowledgeType

false

AdministrationQueue

true

AppSpecific

false

ArrivedTime

true

AttachSenderId

false

Authenticated

false

AuthenticationProviderName

false

AuthenticationProviderType

false

Body

true

ConnectorType

false

CorrelationId

true

DefaultBodySize

1024 bytes

DefaultExtensionSize

255 bytes

DefaultLabelSize

255 bytes

DestinationQueue

false

DestinationSymmetricKey

false

DigitalSignature

false

EncryptionAlgorithm

false

Extension

false

HashAlgorithm

false

Id

true

IsFirstInTransaction

false

IsLastInTransaction

false

Label

true

MessageType

false

Priority

false

Recoverable

false

ResponseQueue

true

SenderCertificate

false

SenderId

false

SenderVersion

false

SentTime

true

SourceMachine

false

TimeToBeReceived

false

TimeToReachQueue

false

TransactionId

false

TransactionStatusQueue

false

UseAuthentication

false

UseDeadLetterQueue

false

UseEncryption

false

UseJournalQueue

false

UseTracing

false

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

Workgroup mode

Available

Local computer

Yes

Local computer and direct format name

Yes

Remote computer

Yes

Remote computer and direct format name

Yes

The following code example uses the MessageReadPropertyFilter to restrict the message properties received.

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 retrieves specific groups of Message
		// properties.
		//**************************************************

		public static void Main()
		{
			// Create a new instance of the class.
			MyNewQueue myNewQueue = new MyNewQueue();

			// Retrieve specific sets of Message properties.
			myNewQueue.RetrieveDefaultProperties();
			myNewQueue.RetrieveAllProperties();
			myNewQueue.RetrieveSelectedProperties();

			return;
		}


		//**************************************************
		// Retrieves the default properties for a Message.
		//**************************************************

		public void RetrieveDefaultProperties()
		{

			// Connect to a message queue.
			MessageQueue myQueue = new MessageQueue(".\\myQueue");

			// Specify to retrieve the default properties only.
			myQueue.MessageReadPropertyFilter.SetDefaults();

			// Set the formatter for the Message.
			myQueue.Formatter = new XmlMessageFormatter(new Type[]
				{typeof(String)});

			// Receive the first message in the queue.
			Message myMessage = myQueue.Receive();

			// Display selected properties.
			Console.WriteLine("Label: " + myMessage.Label);
			Console.WriteLine("Body: " + (String)myMessage.Body);

			return;
		}


		//**************************************************
		// Retrieves all properties for a Message.
		//**************************************************

		public void RetrieveAllProperties()
		{

			// Connect to a message queue.
			MessageQueue myQueue = new MessageQueue(".\\myQueue");

			// Specify to retrieve all properties.
			myQueue.MessageReadPropertyFilter.SetAll();

			// Set the formatter for the Message.
			myQueue.Formatter = new XmlMessageFormatter(new Type[]
				{typeof(String)});

			// Receive the first message in the queue.
			Message myMessage = myQueue.Receive();

			// Display selected properties.
			Console.WriteLine("Encryption algorithm: " + 
				myMessage.EncryptionAlgorithm.ToString());
			Console.WriteLine("Body: " + (String)myMessage.Body);

			return;
		}


		//**************************************************
		// Retrieves application-specific properties for a
		// Message.
		//**************************************************

		public void RetrieveSelectedProperties()
		{
			// Connect to a message queue.
			MessageQueue myQueue = new MessageQueue(".\\myQueue");

			// Specify to retrieve selected properties.
			MessagePropertyFilter myFilter = new 
				MessagePropertyFilter();
			myFilter.ClearAll();
			// The following list is a random subset of available properties.
			myFilter.Body = true;
			myFilter.Label = true;
			myFilter.MessageType = true;
			myFilter.Priority = true;
			myQueue.MessageReadPropertyFilter = myFilter;

			// Set the formatter for the Message.
			myQueue.Formatter = new XmlMessageFormatter(new Type[]
				{typeof(String)});

			// Receive the first message in the queue.
			Message myMessage = myQueue.Receive();

			// Display selected properties.
			Console.WriteLine("Message type: " + 
				myMessage.MessageType.ToString());
			Console.WriteLine("Priority: " + 
				myMessage.Priority.ToString());

			return;
			}
	}
}

.NET Framework
Available since 1.1
Return to top
Show: