QueueClient.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() |
Returns without removing the first message in the queue. |
| Peek(Int64) |
Returns without removing the first message in the queue. |
Peek()
Returns without removing the first message in the queue.
public Microsoft.ServiceBus.Messaging.BrokeredMessage Peek ();abstract member Peek : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Peek : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessagePublic Function Peek () As BrokeredMessageReturns
A brokered message. Returns all properties and the message body.
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)
Returns without removing the first message in the queue.
public Microsoft.ServiceBus.Messaging.BrokeredMessage Peek (long fromSequenceNumber);abstract member Peek : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Peek : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessagePublic Function Peek (fromSequenceNumber As Long) As BrokeredMessageParameters
- fromSequenceNumber
- Int64
The starting point from which to browse a message.
Returns
The brokered message.
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.
