Receive Method (MessageQueueTransactionType)

MessageQueue.Receive Method (MessageQueueTransactionType)

.NET Framework 1.1

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.

[Visual Basic]
Overloads Public Function Receive( _
   ByVal transactionType As MessageQueueTransactionType _
) As Message
[C#]
public Message Receive(
 MessageQueueTransactionType transactionType
);
[C++]
public: Message* Receive(
 MessageQueueTransactionType transactionType
);
[JScript]
public function Receive(
   transactionType : MessageQueueTransactionType
) : Message;

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 Type Condition
MessageQueueException An error occurred when accessing a Message Queuing API.
InvalidEnumArgumentException The transactionType parameter is not one of the MessageQueueTransactionType members.

Remarks

Use this overload to receive a message from a queue using a transaction context defined by the transactionType parameter, or wait until there are messages in the queue.

Specify Automatic for the transactionType parameter if there is already an external transaction context attached to the thread that you want to use to receive the message. Specify Single if you want to receive the message as a single internal transaction. You can specify None if you want to receive a message from a transactional queue outside of a transaction context.

The Receive method allows for the synchronous reading of a message, thereby removing it from the queue. Subsequent calls to Receive will return the messages that follow in the queue.

If this method is called to receive a message from a transactional queue, the message that is received would be returned to the queue if the transaction is aborted. The message is not permanently removed from the queue until the transaction is committed.

To read the first message in a queue without removing it from the queue, use the Peek method. The Peek method always returns the first message in the queue, so subsequent calls to the method return the same message unless a higher priority message arrives in the queue. There is no transaction context associated with a message returned by a call to Peek. Because Peek does not remove any messages in the queue, there would be nothing to roll back by a call to Abort.

Use a call to Receive when it is acceptable for the current thread to be blocked while it waits for a message to arrive in the queue. Because this overload of the Receive method specifies an infinite time-out, the application might wait indefinitely. If the application processing should continue without waiting for the message, consider using the asynchronous method, BeginReceive.

The following table shows whether this method is available in various Workgroup modes.

Workgroup Mode Available
Local computer Yes
Local computer + direct format name Yes
Remote computer No
Remote computer + direct format name Yes

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

MessageQueue Class | MessageQueue Members | System.Messaging Namespace | MessageQueue.Receive Overload List | MessageQueueTransactionType | Transactional | ReceiveById | ReceiveByCorrelationId | Peek | BeginReceive

Show:
© 2016 Microsoft