MessageEnumerator クラス

定義

public ref class MessageEnumerator : MarshalByRefObject, IDisposable, System::Collections::IEnumerator

public class MessageEnumerator : MarshalByRefObject, IDisposable, System.Collections.IEnumerator

type MessageEnumerator = class
    inherit MarshalByRefObject
    interface IEnumerator
    interface IDisposable

Public Class MessageEnumerator
Inherits MarshalByRefObject
Implements IDisposable, IEnumerator

継承

Object

MarshalByRefObject

MessageEnumerator

実装

IEnumerator IDisposable

例

次の例では、キュー内のメッセージの動的リストを取得し、 プロパティが にMessagePriority.Lowest設定されているすべてのメッセージをPriorityカウントします。

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

using namespace System;
using namespace System::Messaging;
ref class MyNewQueue
{
public:
   void CountLowestPriority()
   {
      
      // Holds the count of Lowest priority messages.
      UInt32 numberItems = 0;
      
      // Connect to a queue.
      MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );
      
      // Get a cursor into the messages in the queue.
      MessageEnumerator^ myEnumerator = myQueue->GetMessageEnumerator();
      
      // Specify that the messages's priority should be read.
      myQueue->MessageReadPropertyFilter->Priority = true;
      
      // Move to the next message and examine its priority.
      while ( myEnumerator->MoveNext() )
      {
         
         // Increase the count if priority is Lowest.
         if ( myEnumerator->Current->Priority == MessagePriority::Lowest )
                  numberItems++;
      }

      
      // Display final count.
      Console::WriteLine( "Lowest priority messages: {0}", numberItems );
      return;
   }

};

int main()
{
   
   // Create a new instance of the class.
   MyNewQueue^ myNewQueue = gcnew MyNewQueue;
   
   // Output the count of Lowest priority messages.
   myNewQueue->CountLowestPriority();
   return 0;
}

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 uses a cursor to step through the
        // messages in a queue and counts the number of
        // Lowest priority messages.
        //**************************************************

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

            // Output the count of Lowest priority messages.
            myNewQueue.CountLowestPriority();
                        
            return;
        }

        //**************************************************
        // Iterates through messages in a queue and examines
        // their priority.
        //**************************************************
        
        public void CountLowestPriority()
        {
            // Holds the count of Lowest priority messages.
            uint numberItems = 0;

            // Connect to a queue.
            MessageQueue myQueue = new MessageQueue(".\\myQueue");
    
            // Get a cursor into the messages in the queue.
            MessageEnumerator myEnumerator =
                myQueue.GetMessageEnumerator();

            // Specify that the messages's priority should be read.
            myQueue.MessageReadPropertyFilter.Priority = true;

            // Move to the next message and examine its priority.
            while(myEnumerator.MoveNext())
            {
                // Increase the count if priority is Lowest.
                if(myEnumerator.Current.Priority ==
                    MessagePriority.Lowest)
                    
                    numberItems++;
            }

            // Display final count.
            Console.WriteLine("Lowest priority messages: " +
                numberItems.ToString());
            
            return;
        }
    }
}

Imports System.Messaging

Public Class MyNewQueue


        
        ' Provides an entry point into the application.
        '		 
        ' This example uses a cursor to step through the
        ' messages in a queue and counts the number of 
        ' Lowest priority messages.
        

        Public Shared Sub Main()

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

            ' Output the count of Lowest priority messages.
            myNewQueue.CountLowestPriority()

            Return

        End Sub


        
        ' Iterates through messages in a queue and examines
        ' their priority.
        

        Public Sub CountLowestPriority()

            ' Holds the count of Lowest priority messages.
            Dim numberItems As Int32 = 0

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

            ' Get a cursor into the messages in the queue.
            Dim myEnumerator As MessageEnumerator = _
                myQueue.GetMessageEnumerator()

            ' Specify that the messages's priority should be read.
            myQueue.MessageReadPropertyFilter.Priority = True

            ' Move to the next message and examine its priority.
            While myEnumerator.MoveNext()

                ' Increase the count if the priority is Lowest.
                If myEnumerator.Current.Priority = _
                    MessagePriority.Lowest Then
                    numberItems += 1
                End If

            End While

            ' Display final count.
            Console.WriteLine(("Lowest priority messages: " + _
                numberItems.ToString()))

            Return

        End Sub

End Class

注釈

キュー内のメッセージとの動的な対話に使用 MessageEnumerator します。 クラスでMessageQueue使用できるメソッドは、キュー内のメッセージの動的リストを指す、または指定したメソッドが呼び出された時点でキューのコピーを含む配列 (スナップショット) をMessageEnumerator返すことができます。

静的スナップショットとは異なり、列挙子を使用するとコレクションを変更できます。 を MessageEnumerator使用すると、キューからメッセージを削除でき、変更はすぐにキューに反映されます。

列挙子は、キューに対してクエリを実行するときに、キューからメッセージを削除しません。 現在のカーソル位置にあるメッセージに関する情報を返しますが、メッセージはキューに残ります。

は MessageEnumerator 、動的リストの先頭に初期化されたカーソルです。 リストの順序は、メッセージの優先順位に従って、キュー内のメッセージの順序と同じです。 を呼び出 MoveNextすことで、キュー内の最初のメッセージにカーソルを移動できます。 列挙子が初期化されたら、 を使用 MoveNext して、残りのメッセージを順を追って進めることができます。 タイムアウト MoveNext を メソッドに渡すことで、メッセージが使用可能になるのを待つかどうかを指定できます。

列挙子は動的であるため、カーソルの現在位置を超えて追加されるメッセージ (優先順位が低いためなど) に、列挙子からアクセスできます。 カーソルの現在位置の前に挿入されたメッセージにアクセスできません。 を使用して後方にステップ バック MessageEnumeratorすることはできません。 カーソルを使用すると、順方向専用の移動が可能になります。 Resetメソッドを使用すると、カーソルをキューの先頭に戻します。

特定のキューの の MessageEnumerator インスタンスは個別に動作します。 同じキューに適用される 2 つの MessageEnumerator インスタンスを作成できます。 キュー内のメッセージに対して行われる変更 MessageEnumerator は、2 番目の列挙子が最初の列挙子の前に配置されている場合、すぐに 2 番目の列挙子に反映されます。 ただし、2 つの列挙子が同じ位置にあり、そのうちの 1 つがその位置にあるメッセージを削除した場合、他の列挙子が削除されたメッセージのプロパティの Current 値を取得しようとすると、例外がスローされます。

プロパティ

メソッド

明示的なインターフェイスの実装

適用対象

こちらもご覧ください

• Message
• GetMessageEnumerator2()