SubscriptionClient.PeekBatch Method

Definition

Overloads

PeekBatch(Int32)

Returns without removing the first messages in a batch.

PeekBatch(Int64, Int32)

Returns without removing the first messages in a batch.

PeekBatch(Int32)

Returns without removing the first messages in a batch.

public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekBatch (int messageCount);
Parameters
messageCount
Int32

The number of messages in a batch.

Returns

The collection of first messages in a batch.

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.

PeekBatch(Int64, Int32)

Returns without removing the first messages in a batch.

public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekBatch (long fromSequenceNumber, int messageCount);
Parameters
fromSequenceNumber
Int64

The starting point from which to browse a message.

messageCount
Int32

The number of messages in a batch.

Returns

The collection of first messages in a batch.

Applies to