MessageQueue.GetEnumerator Method ()

 
Note: This API is now obsolete.

Enumerates the messages in a queue. GetEnumerator is deprecated. GetMessageEnumerator2 should be used instead.

Namespace:   System.Messaging
Assembly:  System.Messaging (in System.Messaging.dll)

[ObsoleteAttribute("This method returns a MessageEnumerator that implements RemoveCurrent family of methods incorrectly. Please use GetMessageEnumerator2 instead.")]
public IEnumerator GetEnumerator()

Return Value

Type: System.Collections.IEnumerator

A IEnumerator that provides a dynamic connection to the messages in the queue.

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

No

Remote computer and direct format name

Yes

The following code example demonstrates the use of GetEnumerator.


// Connect to a queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");

// Get an IEnumerator object.
System.Collections.IEnumerator enumerator = queue.GetEnumerator();

// Use the IEnumerator object to loop through the messages.
while(enumerator.MoveNext())
{
    // Get a message from the enumerator.
    Message msg = (Message)enumerator.Current;

    // Display the label of the message.
    Console.WriteLine(msg.Label);
}

.NET Framework
Available since 1.1
Return to top
Show: