MessageQueue.MessageReadPropertyFilter-Eigenschaft

Artikel
08/20/2007

Ruft den Eigenschaftenfilter für das Empfangen oder Einsehen von Meldungen ab oder legt diesen fest.

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

Syntax

'Declaration
Public Property MessageReadPropertyFilter As MessagePropertyFilter
'Usage
Dim instance As MessageQueue
Dim value As MessagePropertyFilter

value = instance.MessageReadPropertyFilter

instance.MessageReadPropertyFilter = value

public MessagePropertyFilter MessageReadPropertyFilter { get; set; }

public:
property MessagePropertyFilter^ MessageReadPropertyFilter {
    MessagePropertyFilter^ get ();
    void set (MessagePropertyFilter^ value);
}

/** @property */
public MessagePropertyFilter get_MessageReadPropertyFilter ()

/** @property */
public void set_MessageReadPropertyFilter (MessagePropertyFilter value)

public function get MessageReadPropertyFilter () : MessagePropertyFilter

public function set MessageReadPropertyFilter (value : MessagePropertyFilter)

Eigenschaftenwert

Der MessagePropertyFilter, der von der Warteschlange zum Filtern der Eigenschaften verwendet wird, die mit einer Meldung empfangen oder eingesehen werden.

Ausnahmen

Ausnahmetyp	Bedingung
ArgumentException	Der Filter ist NULL (Nothing in Visual Basic).

Hinweise

Dieser Filter ist ein Satz von booleschen Werten, die die von einer MessageQueue empfangenen oder eingesehenen Meldungseigenschaften einschränken. Wenn die MessageQueue eine Meldung aus der Serverwarteschlange empfängt oder einsieht, werden nur diejenigen Eigenschaften abgerufen, für die der entsprechende MessageReadPropertyFilter-Wert true ist.

In der folgenden Tabelle werden die anfänglichen Eigenschaftenwerte für die MessageReadPropertyFilter-Eigenschaft aufgeführt. Diese Einstellungen entsprechen dem Aufruf von SetDefaults für einen MessagePropertyFilter.

Eigenschaft	Standardwert
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

Der folgenden Tabelle können Sie entnehmen, ob diese Eigenschaft in verschiedenen Arbeitsgruppenmodi verfügbar ist.

Arbeitsgruppenmodus	Verfügbar
Lokaler Computer	Ja
Lokaler Computer + direkter Formatname	Ja
Remotecomputer	Ja
Lokaler Computer + direkter Formatname	Ja

Beispiel

Im folgenden Codebeispiel wird MessageReadPropertyFilter zur Einschränkung der empfangenen Meldungseigenschaften verwendet.

Imports System
Imports System.Messaging

Public Class MyNewQueue


        
        ' Provides an entry point into the application.
        '        
        ' This example retrieves specific groups of Message
        ' properties.
        

        Public Shared Sub Main()

            ' Create a new instance of the class.
            Dim myNewQueue As New MyNewQueue()

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

            Return

        End Sub 'Main


        
        ' Retrieves the default properties for a Message.
        

        Public Sub RetrieveDefaultProperties()

            ' Connect to a message queue.
            Dim myQueue As 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() _
                {GetType([String])})

            ' Receive the first message in the queue.
            Dim myMessage As Message = myQueue.Receive()

            ' Display selected properties.
            Console.WriteLine(("Label: " + myMessage.Label))
            Console.WriteLine(("Body: " + CType(myMessage.Body, _
                [String])))

            Return

        End Sub 'RetrieveDefaultProperties


        
        ' Retrieves all properties for a Message.
        

        Public Sub RetrieveAllProperties()

            ' Connect to a message queue.
            Dim myQueue As New MessageQueue(".\myQueue")

            ' Specify to retrieve all properties.
            myQueue.MessageReadPropertyFilter.SetAll()

            ' Set the formatter for the Message.
            myQueue.Formatter = New XmlMessageFormatter(New Type() _
                {GetType([String])})

            ' Receive the first message in the queue.
            Dim myMessage As Message = myQueue.Receive()

            ' Display selected properties.
            Console.WriteLine(("Encryption algorithm: " + _
                myMessage.EncryptionAlgorithm.ToString()))
            Console.WriteLine(("Body: " + CType(myMessage.Body, _
                [String])))

            Return

        End Sub 'RetrieveAllProperties


        
        ' Retrieves application-specific properties for a
        ' Message.
        

        Public Sub RetrieveSelectedProperties()

            ' Connect to a message queue.
            Dim myQueue As New MessageQueue(".\myQueue")

            ' Specify to retrieve selected properties.
            Dim myFilter As New MessagePropertyFilter()
            myFilter.ClearAll()
            ' The following list is a random subset of 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() _
                {GetType([String])})

            ' Receive the first message in the queue.
            Dim myMessage As Message = myQueue.Receive()

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

            Return

        End Sub 'RetrieveSelectedProperties

End Class 'MyNewQueue

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

#using <system.dll>
#using <system.messaging.dll>

using namespace System;
using namespace System::Messaging;
ref class MyNewQueue
{
public:

   //*************************************************
   // Retrieves the default properties for a Message.
   //*************************************************
   void RetrieveDefaultProperties()
   {
      // Connect to a message queue.
      MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );

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

      // Set the formatter for the Message.
      array<Type^>^p = gcnew array<Type^>(1);
      p[ 0 ] = String::typeid;
      myQueue->Formatter = gcnew XmlMessageFormatter( p );

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

      // Display selected properties.
      Console::WriteLine( "Label: {0}", myMessage->Label );
      Console::WriteLine( "Body: {0}", static_cast<String^>(myMessage->Body) );
      return;
   }


   //*************************************************
   // Retrieves all properties for a Message.
   //*************************************************
   void RetrieveAllProperties()
   {
      // Connect to a message queue.
      MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );

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

      // Set the formatter for the Message.
      array<Type^>^p = gcnew array<Type^>(1);
      p[ 0 ] = String::typeid;
      myQueue->Formatter = gcnew XmlMessageFormatter( p );

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

      // Display selected properties.
      Console::WriteLine( "Encryption algorithm: {0}", myMessage->EncryptionAlgorithm.ToString() );
      Console::WriteLine( "Body: {0}", myMessage->Body );
      return;
   }

   //*************************************************
   // Retrieves application-specific properties for a
   // Message.
   //*************************************************
   void RetrieveSelectedProperties()
   {
      // Connect to a message queue.
      MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );

      // Specify to retrieve selected properties.
      MessagePropertyFilter^ myFilter = gcnew 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.
      array<Type^>^p = gcnew array<Type^>(1);
      p[ 0 ] = String::typeid;
      myQueue->Formatter = gcnew XmlMessageFormatter( p );

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

      // Display selected properties.
      Console::WriteLine( "Message type: {0}", myMessage->MessageType.ToString() );
      Console::WriteLine( "Priority: {0}", myMessage->Priority.ToString() );
      return;
   }
};


//*************************************************
// Provides an entry point into the application.
//         
// This example retrieves specific groups of Message
// properties.
//*************************************************
int main()
{
   // Create a new instance of the class.
   MyNewQueue^ myNewQueue = gcnew MyNewQueue;

   // Retrieve specific sets of Message properties.
   myNewQueue->RetrieveDefaultProperties();
   myNewQueue->RetrieveAllProperties();
   myNewQueue->RetrieveSelectedProperties();
   return 0;
}

package MyProject;

import System.*;
import System.Messaging.*;

/// <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(String[] args)
    {
        // Create a new instance of the class.
        MyNewQueue myNewQueue = new MyNewQueue();
        // Retrieve specific sets of Message properties.
        myNewQueue.RetrieveDefaultProperties();
        myNewQueue.RetrieveAllProperties();
        myNewQueue.RetrieveSelectedProperties();

        return;
    } //main

    //**************************************************
    // 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.get_MessageReadPropertyFilter().SetDefaults();
        // Set the formatter for the Message.
        myQueue.set_Formatter(new XmlMessageFormatter(new Type[]
            { String.class.ToType() }));
        // Receive the first message in the queue.
        Message myMessage = myQueue.Receive();
        // Display selected properties.
        Console.WriteLine("Label: " + myMessage.get_Label());
        Console.WriteLine("Body: " + (String)(myMessage.get_Body()));

        return;
    } //RetrieveDefaultProperties

    //**************************************************
    // 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.get_MessageReadPropertyFilter().SetAll();
        // Set the formatter for the Message.
        myQueue.set_Formatter(new XmlMessageFormatter(new Type[]
            { String.class.ToType() }));
        // Receive the first message in the queue.
        Message myMessage = myQueue.Receive();
        // Display selected properties.
        Console.WriteLine("Encryption algorithm: "
            + myMessage.get_EncryptionAlgorithm().ToString());
        Console.WriteLine("Body: " + (String)(myMessage.get_Body()));
        return;
    } //RetrieveAllProperties

    //**************************************************
    // 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.set_Body(true);
        myFilter.set_Label(true);
        myFilter.set_MessageType(true);
        myFilter.set_Priority(true);
        myQueue.set_MessageReadPropertyFilter(myFilter);
        // Set the formatter for the Message.
        myQueue.set_Formatter(new XmlMessageFormatter(new Type[] 
            { String.class.ToType() }));
        // Receive the first message in the queue.
        Message myMessage = myQueue.Receive();
        // Display selected properties.
        Console.WriteLine("Message type: "
            + myMessage.get_MessageType().ToString());
        Console.WriteLine("Priority: " + myMessage.get_Priority().ToString());

        return;
    } //RetrieveSelectedProperties
} //MyNewQueue

.NET Framework-Sicherheit

Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter .

Plattformen

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Mobile für Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

.NET Compact Framework

Unterstützt in: 2.0

Siehe auch

Referenz

MessageQueue-Klasse
MessageQueue-Member
System.Messaging-Namespace
Peek
Receive
BeginPeek
BeginReceive

Freigeben über