MessageQueue.ReceiveById Method (String, MessageQueueTransaction)
Receives the message that matches the given identifier (from a transactional queue) and immediately raises an exception if no message with the specified identifier currently exists in the queue.
Namespace: System.Messaging
Assembly: System.Messaging (in System.Messaging.dll)
'Declaration Public Function ReceiveById ( _ id As String, _ transaction As MessageQueueTransaction _ ) As Message
Parameters
- id
- Type: System.String
The Id of the message to receive.
- transaction
- Type: System.Messaging.MessageQueueTransaction
The MessageQueueTransaction object.
Return Value
Type: System.Messaging.MessageThe Message whose Id property matches the id parameter passed in.
| Exception | Condition |
|---|---|
| ArgumentNullException | The id parameter is Nothing. -or- The transaction parameter is Nothing. |
| InvalidOperationException | The message with the specified id could not be found. |
| MessageQueueException | The queue is non-transactional. -or- An error occurred when accessing a Message Queuing method. |
Use this method to read a message with a known identifier and remove it from the queue, using the internal transaction context defined by the transaction parameter. This method throws an exception immediately if the message is not in the queue
The Id property of a message is unique across the Message Queuing enterprise, so there will be at most one message in the queue that matches the given id parameter.
Because this method is called on 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.
Two other methods allow you to receive messages from a queue. The Receive method returns the first message in the queue, and the ReceiveByCorrelationId(String) method is used to retrieve an acknowledgment, report, or application-generated response message that was created as a result of a message sent to the queue.
To read a message with a specified identifier without removing it from the queue, use the PeekById(String) method. The PeekById(String) 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 PeekById(String). Because PeekById(String) does not remove any messages in the queue, there would be nothing to roll back if the transaction were aborted.
The following table shows whether this method is available in various Workgroup modes.
Workgroup mode | Available |
|---|---|
Local computer | Yes |
Local computer and direct format name | Yes |
Remote computer | No |
Remote computer and direct format name | Yes |
- 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, 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.
