ReceiveByCorrelationId(String,TimeSpan,MessageQueueTransaction) Method

Receives the message that matches the given correlation identifier (from a transactional queue) and waits until either a message with the specified correlation identifier is available in the queue, or the time-out expires.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overloads Function ReceiveByCorrelationId( _
   ByVal correlationId As String, _
   ByVal timeout As TimeSpan, _
   ByVal transaction As MessageQueueTransaction _
) As Message

'Usage
 
Dim instance As MessageQueue
Dim correlationId As String
Dim timeout As TimeSpan
Dim transaction As MessageQueueTransaction
Dim value As Message
 
value = instance.ReceiveByCorrelationId(correlationId, timeout, transaction)

public Message ReceiveByCorrelationId( 
   string correlationId,
   TimeSpan timeout,
   MessageQueueTransaction transaction
)

public:
Message^ ReceiveByCorrelationId( 
   String^ correlationId,
   TimeSpan timeout,
   MessageQueueTransaction^ transaction
)

Parameters

correlationId: The CorrelationId of the message to receive.
timeout: A System.TimeSpan that indicates the time to wait until a new message is available for inspection.
transaction: The MessageQueueTransaction object.

Return Value

The Message whose CorrelationId matches the parameter passed in.

Exceptions

Exception	Description
System.ArgumentNullException	The correlationId parameter is null.-or- The transaction parameter is null.
System.ArgumentException	The value specified for the timeout parameter is not valid, possibly timeout is less than System.TimeSpan.Zero or greater than InfiniteTimeout.
MessageQueueException	The message with the specified correlationId does not exist in the queue and did not arrive before the time-out expired.-or- The queue is non-transactional.-or- 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