Receive(MessageQueueTransactionType) Method

Receives the first message available in the queue referenced by the MessageQueue. This call is synchronous, and blocks the current thread of execution until a message is available.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overloads Function Receive( _
   ByVal transactionType As MessageQueueTransactionType _
) As Message

'Usage
 
Dim instance As MessageQueue
Dim transactionType As MessageQueueTransactionType
Dim value As Message
 
value = instance.Receive(transactionType)

public Message Receive( 
   MessageQueueTransactionType transactionType
)

public:
Message^ Receive( 
   MessageQueueTransactionType transactionType
)

Parameters

transactionType: One of the MessageQueueTransactionType values, describing the type of transaction context to associate with the message.

Return Value

A Message that references the first message available in the queue.

Exceptions

Exception	Description
MessageQueueException	An error occurred when accessing a Message Queuing method.
System.ComponentModel.InvalidEnumArgumentException	The transactionType parameter is not one of the MessageQueueTransactionType members.

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