ReceiveByLookupId(MessageLookupAction,Int64,MessageQueueTransaction) Method
Introduced in MSMQ 3.0. Receives a specific message from a transactional queue. The message can be specified by a lookup identifier or by its position at the front or end of the queue.
Syntax
'Declaration Public Overloads Function ReceiveByLookupId( _ ByVal action As MessageLookupAction, _ ByVal lookupId As Long, _ ByVal transaction As MessageQueueTransaction _ ) As Message
'Usage Dim instance As MessageQueue Dim action As MessageLookupAction Dim lookupId As Long Dim transaction As MessageQueueTransaction Dim value As Message value = instance.ReceiveByLookupId(action, lookupId, transaction)
public Message ReceiveByLookupId( MessageLookupAction action, long lookupId, MessageQueueTransaction transaction )
public: Message^ ReceiveByLookupId( MessageLookupAction action, int64 lookupId, MessageQueueTransaction^ transaction )
Parameters
- action
- 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.
- lookupId
- The LookupId of the message to receive, or 0. 0 is used when accessing the first or last message in the queue.
- transaction
- The MessageQueueTransaction object.
Return Value
Exceptions
Exception | Description |
---|---|
System.PlatformNotSupportedException | MSMQ 3.0 is not installed. |
System.InvalidOperationException | The message with the specified lookupId could not be found. |
MessageQueueException | An error occurred when accessing a Message Queuing method.-or- The queue is non-transactional. |
System.ComponentModel.InvalidEnumArgumentException | The action parameter is not one of the MessageLookupAction 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
See Also