MessageQueue.MessageReadPropertyFilter プロパティ

.NET Framework クラス ライブラリ リファレンス

MessageQueue.MessageReadPropertyFilter プロパティ

メッセージの受信またはピークに使用するプロパティ フィルタを取得または設定します。

名前空間: System.Messaging
アセンブリ: System.Messaging (system.messaging.dll 内)
構文

Visual Basic (宣言)

Public Property MessageReadPropertyFilter As
 MessagePropertyFilter

Visual Basic (使用法)

Dim instance As MessageQueue
Dim value As MessagePropertyFilter

value = instance.MessageReadPropertyFilter

instance.MessageReadPropertyFilter = value

C#

public MessagePropertyFilter MessageReadPropertyFilter { get;
 set; }

C++

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

J#

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

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

JScript

public function get MessageReadPropertyFilter
 () : MessagePropertyFilter

public function set MessageReadPropertyFilter
 (value : MessagePropertyFilter)

プロパティ値
メッセージごとに受信またはピークするプロパティのセットをフィルタ処理するためにキューが使用する MessagePropertyFilter。

例外

例外の種類	条件
ArgumentException	フィルタが null 参照 (Visual Basic では Nothing) です。

解説

このフィルタは、MessageQueue が受信またはピークするメッセージ プロパティを制限するブール値のセットです。MessageQueue は、サーバー キューからメッセージを受信またはピークするときに、対応する MessageReadPropertyFilter 値が true であるプロパティだけを取得します。

MessageReadPropertyFilter プロパティのプロパティ初期値を次の表に示します。これらの設定は、MessagePropertyFilter に対してSetDefaults を呼び出した場合と同一です。

プロパティ	既定値
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 バイト
DefaultExtensionSize	255 バイト
DefaultLabelSize	255 バイト
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

このプロパティが各種のワークグループ モードで使用できるかどうかを次の表に示します。

ワークグループ モード	使用可否
ローカル コンピュータ	○
ローカル コンピュータと直接書式名	○
リモート コンピュータ	○
リモート コンピュータと直接書式名	○

使用例

MessageReadPropertyFilter を使用して、受信するメッセージ プロパティを制限するコード例を次に示します。

Visual Basic

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

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

C++

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

J#

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 のセキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
MessageQueue クラス
MessageQueue メンバ
System.Messaging 名前空間
Peek
Receive
BeginPeek
BeginReceive