MessageQueue.ReceiveByLookupId Method (MessageLookupAction, Int64, MessageQueueTransactionType)
Introduced in MSMQ 3.0. Receives a specific message from the queue, using the specified transaction context. The message can be specified by a lookup identifier or by its position at the front or end of the queue.
Assembly: System.Messaging (in System.Messaging.dll)
public Message ReceiveByLookupId( MessageLookupAction action, long lookupId, MessageQueueTransactionType transactionType )
- Type: System.Messaging.MessageLookupAction
One of the MessageLookupAction values, specifying how the message is read in the queue. Specify one of the following:
MessageLookupAction.Current: Receives the message specified by lookupId and removes it from the queue.
MessageLookupAction.Next: Receives the message following the message specified by lookupId and removes it from the queue.
MessageLookupAction.Previous: Receives the message preceding the message specified by lookupId and removes it from the queue.
MessageLookupAction.First: Receives the first message in the queue and removes it from the queue. The lookupId parameter must be set to 0.
MessageLookupAction.Last: Receives the last message in the queue and removes it from the queue. The lookupId parameter must be set to 0.
- Type: System.Int64
The LookupId of the message to receive, or 0. 0 is used when accessing the first or last message in the queue.
MSMQ 3.0 is not installed.
The message with the specified lookupId could not be found.
An error occurred when accessing a Message Queuing method.
The action parameter is not one of the MessageLookupAction members.
The transactionType parameter is not one of the MessageQueueTransactionType members.
Use this method to read a message with a known lookup identifier and remove it from the queue, using a transaction context defined by the transactionType parameter. This method throws an exception immediately if the message is not in the queue.
The LookupId property of a message is unique to the queue where the message resides, so there will be at most one message in the queue that matches the given lookupId parameter.
To read a message with a specified identifier without removing it from the queue, use the PeekByLookupId method. There is no transaction context associated with a message returned by a call to PeekByLookupId. Because PeekByLookupId does not remove any messages from the queue, there would be nothing to roll back if the transaction were aborted.
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.
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.
The following table shows whether this method is available in various Workgroup modes.
Local computer and direct format name
Remote computer and direct format name
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.