Receive(TimeSpan,Cursor,MessageQueueTransaction) Method

Receives the current message in the queue, using a specified cursor. If no message is available, this method waits until either a message is available, or the time-out expires.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overloads Function Receive( _
   ByVal timeout As TimeSpan, _
   ByVal cursor As Cursor, _
   ByVal transaction As MessageQueueTransaction _
) As Message

'Usage
 
Dim instance As MessageQueue
Dim timeout As TimeSpan
Dim cursor As Cursor
Dim transaction As MessageQueueTransaction
Dim value As Message
 
value = instance.Receive(timeout, cursor, transaction)

public Message Receive( 
   TimeSpan timeout,
   Cursor cursor,
   MessageQueueTransaction transaction
)

public:
Message^ Receive( 
   TimeSpan timeout,
   Cursor^ cursor,
   MessageQueueTransaction^ transaction
)

Parameters

timeout: A System.TimeSpan that indicates the time to wait until a new message is available for inspection.
cursor: A Cursor that maintains a specific position in the message queue.
transaction: The MessageQueueTransaction object.

Return Value

A Message that references a message in the queue.

Exceptions

Exception	Description
System.ArgumentNullException	The cursor 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	A message did not arrive in the queue 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