MessageQueue.GetMessageEnumerator メソッド

定義

名前空間:

System.Messaging

アセンブリ:

System.Messaging.dll

注意事項

This method returns a MessageEnumerator that implements RemoveCurrent family of methods incorrectly. Please use GetMessageEnumerator2 instead.

キューにあるすべてのメッセージに対して列挙子オブジェクトを作成します。 GetMessageEnumerator() は非推奨とされます。 代わりに GetMessageEnumerator2() を使用します。

public:
 System::Messaging::MessageEnumerator ^ GetMessageEnumerator();

[System.Obsolete("This method returns a MessageEnumerator that implements RemoveCurrent family of methods incorrectly. Please use GetMessageEnumerator2 instead.")]
public System.Messaging.MessageEnumerator GetMessageEnumerator ();

[<System.Obsolete("This method returns a MessageEnumerator that implements RemoveCurrent family of methods incorrectly. Please use GetMessageEnumerator2 instead.")>]
member this.GetMessageEnumerator : unit -> System.Messaging.MessageEnumerator

Public Function GetMessageEnumerator () As MessageEnumerator

戻り値

MessageEnumerator

キューに含まれるメッセージを保持する MessageEnumerator。

属性

ObsoleteAttribute

例

次のコード例では、キュー内のメッセージの動的リストを取得し、 プロパティが に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

注釈

GetMessageEnumerator は、キュー内のすべてのメッセージの動的リストを作成します。 を返す を呼び出RemoveCurrentすことで、列挙子の現在の位置にあるメッセージをMessageEnumeratorGetMessageEnumeratorキューから削除できます。

カーソルはキュー内のメッセージの動的リストに関連付けられているため、メッセージが現在のカーソル位置を超えている場合、列挙はキュー内のメッセージに加えた変更を反映します。 たとえば、列挙子は、カーソルの現在の位置を超えて配置された優先度の低いメッセージに自動的にアクセスできますが、その位置の前に挿入された優先度の高いメッセージにはアクセスできません。 ただし、 を呼び出ResetMessageEnumeratorすことで列挙体をリセットし、カーソルをリストの先頭に戻すことができます。

列挙内のメッセージの順序はキュー内の順序を反映するため、優先度の高いメッセージは優先順位の低いメッセージの前に表示されます。

メッセージへの動的接続ではなく、キュー内のメッセージの静的スナップショットが必要な場合は、 を呼び出します GetAllMessages。 このメソッドは、 メソッドが呼び出されたときの Message メッセージを表す オブジェクトの配列を返します。

次の表は、このメソッドがさまざまなワークグループ モードで使用できるかどうかを示しています。

ワークグループ モード	利用可能
ローカル コンピューター	はい
ローカル コンピューターと直接の形式名	はい
リモート コンピューター	はい
リモート コンピューターと直接形式の名前	はい

こちらもご覧ください

• GetAllMessages()
• GetMessageEnumerator2()
• GetMessageQueueEnumerator()