System.Messaging Reference (Document! X Sample)
ReceiveById(String,MessageQueueTransaction) Method



System.Messaging Namespace > MessageQueue Class > ReceiveById Method : ReceiveById(String,MessageQueueTransaction) Method
The Id of the message to receive.
The MessageQueueTransaction object.
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.
Syntax
'Declaration
 
Public Overloads Function ReceiveById( _
   ByVal id As String, _
   ByVal transaction As MessageQueueTransaction _
) As Message
'Usage
 
Dim instance As MessageQueue
Dim id As String
Dim transaction As MessageQueueTransaction
Dim value As Message
 
value = instance.ReceiveById(id, transaction)

Parameters

id
The Id of the message to receive.
transaction
The MessageQueueTransaction object.

Return Value

The Message whose Id property matches the id parameter passed in.
Exceptions
ExceptionDescription
The id parameter is null.-or- The transaction parameter is null.
The message with the specified id could not be found.
The queue is non-transactional.-or- An error occurred when accessing a Message Queuing method.
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

Reference

MessageQueue Class
MessageQueue Members
Overload List