TopicClient.Peek Method

  • Reference

Definition

Namespace:
Microsoft.ServiceBus.Messaging
Assembly:
Microsoft.ServiceBus.dll
Package:
WindowsAzure.ServiceBus v6.2.2

Overloads

Peek()

Peeks a BrokeredMessage from current queue/topic.
Peek(Int64)

Peeks a BrokeredMessage from current queue/topic.

Peek()

Peeks a BrokeredMessage from current queue/topic.

public Microsoft.ServiceBus.Messaging.BrokeredMessage Peek ();
abstract member Peek : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Peek : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage
Public Function Peek () As BrokeredMessage

Returns

BrokeredMessage

return the peeked BrokeredMessage. A null is return if peek operation cannot obtain the message within OperationTimeout.

Remarks

A Null can be return by this API if operation exceeded the timeout specified, or the operations succeeded but there are no more messages to be received.

Applies to

Peek(Int64)

Peeks a BrokeredMessage from current queue/topic.

public Microsoft.ServiceBus.Messaging.BrokeredMessage Peek (long fromSequenceNumber);
abstract member Peek : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Peek : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessage
Public Function Peek (fromSequenceNumber As Long) As BrokeredMessage

Parameters

fromSequenceNumber
Int64

The sequence number of message to start peeking from.

Returns

BrokeredMessage

return the peeked BrokeredMessage. A null is return if peek operation cannot obtain the message within OperationTimeout.

Remarks

A Null can be return by this API if operation exceeded the timeout specified, or the operations succeeded but there are no more messages to be received.

Applies to