MessageQueue.GetMessageEnumerator Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Caution
This method returns a MessageEnumerator that implements RemoveCurrent family of methods incorrectly. Please use GetMessageEnumerator2 instead.
Creates an enumerator object for all the messages in the queue. GetMessageEnumerator() is deprecated. GetMessageEnumerator2() should be used instead.
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.MessageEnumeratorPublic Function GetMessageEnumerator () As MessageEnumeratorReturns
The MessageEnumerator holding the messages that are contained in the queue.
- Attributes
Remarks
GetMessageEnumerator creates a dynamic list of all the messages in a queue. You can remove from the queue the message at the enumerator's current position by calling RemoveCurrent for the MessageEnumerator that GetMessageEnumerator returns.
Because the cursor is associated with the dynamic list of messages in the queue, the enumeration reflects any modification you make to the messages in the queue, if the message is beyond the current cursor position. For example, the enumerator can automatically access a lower-priority message placed beyond the cursor's current position, but not a higher-priority message inserted before that position. However, you can reset the enumeration, thereby moving the cursor back to the beginning of the list, by calling Reset for the MessageEnumerator.
The order of the messages in the enumeration reflects their order in the queue, so higher-priority messages will appear before lower-priority ones.
If you want a static snapshot of the messages in the queue rather than a dynamic connection to them, call GetAllMessages. This method returns an array of Message objects, which represent the messages at the time the method was called.
The following table shows whether this method is available in various Workgroup modes.
| Workgroup mode | Available |
|---|---|
| Local computer | Yes |
| Local computer and direct format name | Yes |
| Remote computer | Yes |
| Remote computer and direct format name | Yes |
