MessageReceiver.Receive Method (MessageReceipt, TimeSpan)

Receives a BrokeredMessage from the current queue or topic.

Namespace:  Microsoft.ServiceBus.Messaging
Assembly:  Microsoft.ServiceBus.Messaging (in Microsoft.ServiceBus.Messaging.dll)

Syntax

'Declaration
Public Function Receive ( _
    receipt As MessageReceipt, _
    serverWaitTime As TimeSpan _
) As BrokeredMessage
'Usage
Dim instance As MessageReceiver
Dim receipt As MessageReceipt
Dim serverWaitTime As TimeSpan
Dim returnValue As BrokeredMessage

returnValue = instance.Receive(receipt, _
    serverWaitTime)
public BrokeredMessage Receive(
    MessageReceipt receipt,
    TimeSpan serverWaitTime
)
public:
BrokeredMessage^ Receive(
    MessageReceipt^ receipt, 
    TimeSpan serverWaitTime
)
member Receive : 
        receipt:MessageReceipt * 
        serverWaitTime:TimeSpan -> BrokeredMessage 
public function Receive(
    receipt : MessageReceipt, 
    serverWaitTime : TimeSpan
) : BrokeredMessage

Parameters

  • serverWaitTime
    Type: System.TimeSpan
    The server wait time before the operation times out.

Return Value

Type: Microsoft.ServiceBus.Messaging.BrokeredMessage
A BrokeredMessage.

Exceptions

Exception Condition
TimeoutException

The operation times out.

See Also

Reference

MessageReceiver Class

Receive Overload

Microsoft.ServiceBus.Messaging Namespace