MessageQueue.GetMessageEnumerator メソッド

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

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();

member this.GetMessageEnumerator : unit -> System.Messaging.MessageEnumerator

[<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 。

属性

ObsoleteAttribute

注釈

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

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

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

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

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

こちらもご覧ください

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