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

Примеры

Следующий пример кода получает динамический список сообщений в очереди и подсчитывает все сообщения со свойством Priority , равным MessagePriority.Lowest.

#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 объекта .

Поскольку курсор связан с динамическим списком сообщений в очереди, перечисление отражает любые изменения, внесенные в сообщения в очереди, если сообщение находится за пределами текущего положения курсора. Например, перечислитель может автоматически получить доступ к сообщению с более низким приоритетом, размещенном за пределами текущей позиции курсора, но не к сообщению с более высоким приоритетом, вставленном перед этой позицией. Однако можно сбросить перечисление, тем самым переместив курсор обратно в начало списка, вызвав Reset для MessageEnumerator.

Порядок сообщений в перечислении отражает их порядок в очереди, поэтому сообщения с более высоким приоритетом будут отображаться перед сообщениями с более низким приоритетом.

Если требуется статическое snapshot сообщений в очереди, а не динамическое подключение к ним, вызовите .GetAllMessages Этот метод возвращает массив Message объектов , представляющих сообщения на момент вызова метода.

В следующей таблице показано, доступен ли этот метод в различных режимах рабочей группы.

Режим рабочей группы	Доступно
Локальный компьютер	Да
Имя локального компьютера и прямого формата	Да
Удаленный компьютер	Да
Имя удаленного компьютера и прямого формата	Да

См. также раздел

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