SubscriptionClient.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 ();
Returns

The returned 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.

Peek(Int64)

Returns without removing the first message in the queue.

public Microsoft.ServiceBus.Messaging.BrokeredMessage Peek (long fromSequenceNumber);
Parameters
fromSequenceNumber
Int64

The starting point from which to browse a message.

Returns

The returned 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