Visual Basic Code Example: Correlation Identifier Filters


This example provides a private Sub procedure that retrieves all the messages in a queue that have a given correlation identifier. Filtering is done by peeking at the MSMQMessage.CorrelationId property of each message in the queue and removing only those messages whose property value matches a known correlation identifier.


Message Queuing requires a 20-byte correlation identifier.

To filter messages by correlation identifier

  1. Declare the objects needed to read the messages in the queue.


When declaring the MSMQMessage object when reading messages, the New keyword cannot be used.

  1. Obtain an MSMQQueueInfo object. The following example initializes the MSMQQueueInfo object by setting the MSMQQueueInfo.PathName property using the computer name and queue name provided by the caller.

    Because this procedure sets the MSMQQueueInfo.PathName property of the MSMQQueueInfo object, Message Queuing must obtain the format name of the queue before opening the queue. The format name of a public queue must be retrieved from the directory service, and the format name of a local private queue can be obtained from information stored on the local computer. However, a remote private queue cannot be opened unless the MSMQQueueInfo.FormatName property is set with a direct format name. This procedure can be modified to receive the format name from the caller or to generate a direct format name. The applicable format name can then be used to set the FormatName property. For more information, see Format Names.

  2. Call MSMQQueueInfo.Open to open the queue with receive access. When opening a queue with receive access the application can peek at or retrieve the messages in the queue.

  3. Call MSMQQueue.PeekCurrent to initialize the cursor. This call points the cursor to the first message in the queue.

  4. Using a loop, filter out the messages with the correlation identifier provided by the caller.

    If the message has the correct correlation identifier, the call to MSMQQueue.ReceiveCurrent removes the message and Message Queuing moves the cursor to the next message.

    If the message does not have the correct correlation identifier, the call to MSMQQueue.PeekNext moves the cursor to the next message.

  5. When there are no messages left, call MSMQQueue.Close to release resources used to open queue and exit the Sub procedure.

The following code example can be run on all versions of Message Queuing.

Private Sub FilterByCorrelationId( _
                                  strQueueName As String, _
                                  strComputerName As String, _
                                  varCorrelationId As Variant _

  ' Declare Message Queuing objects.
  Dim qinfo As New MSMQQueueInfo
  Dim q As MSMQQueue
  Dim msg As MSMQMessage
  Dim iC As Integer
  Dim fEqual As Boolean

  ' Set the path name in the MSMQQueueInfo object.
  qinfo.PathName = strComputerName & "\" & strQueueName

  ' Open the public queue with receive access.
  On Error GoTo ErrorHandler
  Set q = qinfo.Open(Access:=MQ_RECEIVE_ACCESS, ShareMode:=MQ_DENY_NONE)

  ' Initialize the cursor.
  Set msg = q.PeekCurrent(ReceiveTimeout:=1000)

  ' Peek at the messages using the cursor.
  Do While Not msg Is Nothing
    ' Check if the message has the requested correlation identifier.
    fEqual = True
    For iC = 0 To 19
      ' Test if the elements of the correlation IDs are equal.
      If msg.CorrelationId(iC) <> varCorrelationId(iC) Then
       fEqual = False
      End If
    Next iC

    If fEqual Then
      ' Remove the message.
      Set msg = q.ReceiveCurrent(ReceiveTimeout:=1000)
      MsgBox "A message with the requested correlation identifier was removed."
      Set msg = q.PeekCurrent(ReceiveTimeout:=1000)
      Set msg = q.PeekNext(ReceiveTimeout:=1000)
    End If


  ' Close the queue.
  Exit Sub

  MsgBox "Error " + Hex(Err.Number) + " was returned. " + Chr(13) + _
         "Description: " + Err.Description
  If Not q Is Nothing And q.IsOpen2 Then
End Sub

Community Additions