你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

QueueClient.Receive 方法

定义

命名空间:

Microsoft.ServiceBus.Messaging

程序集:

Microsoft.ServiceBus.dll

包:

WindowsAzure.ServiceBus v6.2.2

重载

Receive()	使用 Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver接收消息。
Receive(Int64)	使用 Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver接收延迟的消息。 此方法仅适用于延迟消息，不适用于常规消息。
Receive(TimeSpan)	使用 Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver接收消息。

Receive()

使用 Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver接收消息。

public Microsoft.ServiceBus.Messaging.BrokeredMessage Receive ();

abstract member Receive : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Receive : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage

Public Function Receive () As BrokeredMessage

返回

BrokeredMessage

表示 BrokeredMessage 收到的消息的 。 如果没有可接收的消息，该方法将返回 NULL，你可以稍后重试该操作。

例外

OperationCanceledException

如果客户端实体已关闭或中止，则引发。

TimeoutException

如果消息接收操作超时，则引发。

UnauthorizedAccessException

如果发生 I/O 或安全错误，则引发。

MessagingEntityNotFoundException

如果与操作关联的消息传送实体不存在或已被删除，则引发。

MessagingException

如果用户代码执行了一些意外操作，或者服务总线网关关闭，则引发。 检查异常消息中是否存在实际错误。

注解

如果操作超出指定的超时时间，或者操作成功，但没有更多消息要接收，则此 API 可以返回 Null。

Receive(Int64)

使用 Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver接收延迟的消息。 此方法仅适用于延迟消息，不适用于常规消息。

public Microsoft.ServiceBus.Messaging.BrokeredMessage Receive (long sequenceNumber);

abstract member Receive : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Receive : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessage

Public Function Receive (sequenceNumber As Long) As BrokeredMessage

参数

sequenceNumber

Int64

要接收的延迟消息的序列号。

返回

BrokeredMessage

表示 BrokeredMessage 收到的消息的 。 如果没有可接收的消息，该方法将返回 NULL，你可以稍后重试该操作。

例外

OperationCanceledException

如果客户端实体已关闭或中止，则引发。

注解

如果操作超过指定的超时，或者操作成功，但找不到具有所请求的 sequenceNumber 的消息，则此 API 可以返回 Null。

Receive(TimeSpan)

使用 Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver接收消息。

public Microsoft.ServiceBus.Messaging.BrokeredMessage Receive (TimeSpan serverWaitTime);

abstract member Receive : TimeSpan -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Receive : TimeSpan -> Microsoft.ServiceBus.Messaging.BrokeredMessage

Public Function Receive (serverWaitTime As TimeSpan) As BrokeredMessage

参数

serverWaitTime

TimeSpan

服务器在超时之前等待接收消息的时间跨度。

返回

BrokeredMessage

表示 BrokeredMessage 收到的消息的 。 如果没有可接收的消息，该方法将返回 NULL，你可以稍后重试该操作。

例外

ArgumentOutOfRangeException

如果 为负， serverWaitTime 则引发。

TimeoutException

如果消息接收操作超时，则引发。

OperationCanceledException

如果客户端实体已关闭或中止，则引发。

UnauthorizedAccessException

如果发生 I/O 或安全错误，则引发。

MessagingEntityNotFoundException

如果与操作关联的消息传送实体不存在或已被删除，则引发。

MessagingException

如果用户代码执行了一些意外操作，或者服务总线网关关闭，则引发。 检查异常消息中是否存在实际错误。

注解

如果操作超出指定的超时时间，或者操作成功，但没有更多消息要接收，则此 API 可以返回 Null。