MessageQueueCriteria Class

 

Filters message queues when performing a query using the MessageQueue class's GetPublicQueues method.

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

System.Object
  System.Messaging.MessageQueueCriteria

Public Class MessageQueueCriteria

NameDescription
System_CAPS_pubmethodMessageQueueCriteria()

Initializes a new instance of the MessageQueueCriteria class.

NameDescription
System_CAPS_pubpropertyCategory

Gets or sets the category by which to filter queues in the network.

System_CAPS_pubpropertyCreatedAfter

Gets or sets the lower boundary of the queue creation date and time by which to filter queues on the network.

System_CAPS_pubpropertyCreatedBefore

Gets or sets the upper boundary of the queue creation date and time by which to filter queues on the network.

System_CAPS_pubpropertyLabel

Gets or sets the label by which to filter queues in the network.

System_CAPS_pubpropertyMachineName

Gets or sets the computer name by which to filter queues in the network.

System_CAPS_pubpropertyModifiedAfter

Gets or sets the lower boundary of the queue modification date and time by which to filter queues on the network.

System_CAPS_pubpropertyModifiedBefore

Gets or sets the upper boundary of the queue modification date and time by which to filter queues on the network.

NameDescription
System_CAPS_pubmethodClearAll()

Clears all properties from being built into a filter and puts all property values into a "not set" state.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

The MessageQueue class provides a number of methods that enable you to filter your search for public queues on the network. Specific methods for filtering by queue label, category, or server location are the GetPublicQueuesByLabel, GetPublicQueuesByCategory, and GetPublicQueuesByMachine.

The MessageQueueCriteria class, when used with the GetPublicQueues method, allows you to refine your filter. You can specify search criteria not specifically addressed through one of the GetPublicQueuesBy* methods, or by multiple criteria. You can pass a MessageQueueCriteria instance into the GetPublicQueues method in order to search, for example, by queue creation or modification times, the computer the queue resides on, the queue label or category, or any combination of these properties.

When filtering by multiple properties, the criteria are composed by applying the AND operator to the set of properties. Thus, when you specify a value for the CreatedAfter property together with the MachineName property, you are asking for all queues that were created after a specified time and that reside on a specific computer.

When you set any property, the method that sets the property also sets a flag to indicate that it should be included in the filter you are building. You cannot remove individual properties from the search filter. Instead, you remove all properties from the filter by calling ClearAll, and then set the properties that you do want to build into the search filter. ClearAll resets all properties into a "not set" default state.

You must set a property before trying to read it; otherwise, an exception is thrown.

The following example iterates through message queues and displays the path of each queue that was created in the last day and that exists on the computer "MyComputer".

Imports System
Imports System.Messaging


Public Class MyNewQueue


        '
        ' Provides an entry point into the application.
        '		 
        ' This example uses a cursor to step through the
        ' message queues and list the public queues on the
        ' network that specify certain criteria.


        Public Shared Sub Main()

            ' Create a new instance of the class.
            Dim myNewQueue As New MyNewQueue()

            ' Output the count of Lowest priority messages.
            myNewQueue.ListPublicQueuesByCriteria()

            Return

        End Sub 'Main



        ' Iterates through message queues and displays the
        ' path of each queue that was created in the last
        ' day and that exists on the computer "MyComputer". 


        Public Sub ListPublicQueuesByCriteria()

            Dim numberQueues As Int32 = 0

            ' Specify the criteria to filter by.
            Dim myCriteria As New MessageQueueCriteria()
            myCriteria.MachineName = "MyComputer"
            myCriteria.CreatedAfter = DateTime.Now.Subtract(New _
                TimeSpan(1, 0, 0, 0))


            ' Get a cursor into the queues on the network.
            Dim myQueueEnumerator As MessageQueueEnumerator = _
                MessageQueue.GetMessageQueueEnumerator(myCriteria)

            ' Move to the next queue and read its path.
            While myQueueEnumerator.MoveNext()
                ' Increase the count if the priority is Lowest.
                Console.WriteLine(myQueueEnumerator.Current.Path)
                numberQueues += 1
            End While

            ' Handle no queues matching the criteria.
            If numberQueues = 0 Then
                Console.WriteLine("No queues match the criteria.")
            End If

            Return

        End Sub 'ListPublicQueuesByCriteria

End Class 'MyNewQueue

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: