PeekByCorrelationId(String) Method

Peeks the message that matches the given correlation identifier and immediately raises an exception if no message with the specified correlation identifier currently exists in the queue.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overloads Function PeekByCorrelationId( _
   ByVal correlationId As String _
) As Message

'Usage
 
Dim instance As MessageQueue
Dim correlationId As String
Dim value As Message
 
value = instance.PeekByCorrelationId(correlationId)

public Message PeekByCorrelationId( 
   string correlationId
)

public:
Message^ PeekByCorrelationId( 
   String^ correlationId
)

Parameters

correlationId: The CorrelationId of the message to peek.

Return Value

The Message whose CorrelationId matches the parameter passed in.

Exceptions

Exception	Description
System.ArgumentNullException	The correlationId parameter is null.
System.InvalidOperationException	The message with the specified correlationId could not be found.
MessageQueueException	An error occurred when accessing a Message Queuing method.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

MessageQueue Class
MessageQueue Members
Overload List