QueueClient.Peek Method

Definition

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.BrokeredMessage
Public Function Peek () As BrokeredMessage

Returns

BrokeredMessage

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.BrokeredMessage
Public Function Peek (fromSequenceNumber As Long) As BrokeredMessage

Parameters

fromSequenceNumber
Int64

The starting point from which to browse a message.

Returns

BrokeredMessage

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.

Applies to