TopicClient.Peek Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
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
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
Azure SDK for .NET