Export (0) Print
Expand All

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.

Implements

IEnumerable.GetEnumerator()

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

Supported in: 1.1, 1.0
Obsolete (compiler warning) in 4.5.2
Obsolete (compiler warning) in 4.5.1
Obsolete (compiler warning) in 4.5
Obsolete (compiler warning) in 4
Obsolete (compiler warning) in 3.5
Obsolete (compiler warning) in 3.5 SP1
Obsolete (compiler warning) in 3.0
Obsolete (compiler warning) in 3.0 SP1
Obsolete (compiler warning) in 3.0 SP2
Obsolete (compiler warning) in 2.0
Obsolete (compiler warning) in 2.0 SP1
Obsolete (compiler warning) in 2.0 SP2

.NET Framework Client Profile

Obsolete (compiler warning) in 4
Obsolete (compiler warning) in 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft