MessageQueue.MessageReadPropertyFilter Propriété

Définition

Espace de noms:

System.Messaging

Assembly:

System.Messaging.dll

Obtient ou définit le filtre appliqué aux propriétés lors de la réception ou de la lecture de messages.

C#

[System.ComponentModel.Browsable(false)]
[System.Messaging.MessagingDescription("MQ_MessageReadPropertyFilter")]
public System.Messaging.MessagePropertyFilter MessageReadPropertyFilter { get; set; }

Valeur de propriété

MessagePropertyFilter

MessagePropertyFilter utilisé par la file d'attente pour filtrer les propriétés reçues ou lues pour chaque message.

Attributs

BrowsableAttribute MessagingDescriptionAttribute

Exceptions

ArgumentException

Le filtre est null.

Exemples

L’exemple de code suivant utilise pour MessageReadPropertyFilter restreindre les propriétés de message reçues.

C#

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;
            }
    }
}

Remarques

Ce filtre est un ensemble de valeurs booléennes qui limitent les propriétés de message que le MessageQueue reçoit ou affiche. Lorsque le MessageQueue reçoit ou passe un aperçu d’un message de la file d’attente du serveur, il récupère uniquement les propriétés pour lesquelles la MessageReadPropertyFilter valeur est true.

Voici les valeurs de propriété initiales pour la MessageReadPropertyFilter propriété . Ces paramètres sont identiques à l’appel SetDefaults sur un MessagePropertyFilter.

Property	Valeur par défaut
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	1 024 octets
DefaultExtensionSize	255 octets
DefaultLabelSize	255 octets
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

Le tableau suivant indique si cette propriété est disponible dans différents modes de groupe de travail.

Mode groupe de travail	Disponible
Ordinateur local	Oui
Ordinateur local et nom de format direct	Oui
Ordinateur distant	Oui
Ordinateur distant et nom de format direct	Oui

S’applique à

Voir aussi

• Peek()
• Receive()
• BeginPeek()
• BeginReceive()