CloudQueue.PeekMessages(Int32, QueueRequestOptions, OperationContext) Method

Definition

Peeks a message from the queue, using the specified request options and operation context. A peek request retrieves a message from the queue without changing its visibility.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Collections.Generic.IEnumerable<Microsoft.Azure.Storage.Queue.CloudQueueMessage> PeekMessages (int messageCount, Microsoft.Azure.Storage.Queue.QueueRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member PeekMessages : int * Microsoft.Azure.Storage.Queue.QueueRequestOptions * Microsoft.Azure.Storage.OperationContext -> seq<Microsoft.Azure.Storage.Queue.CloudQueueMessage>
override this.PeekMessages : int * Microsoft.Azure.Storage.Queue.QueueRequestOptions * Microsoft.Azure.Storage.OperationContext -> seq<Microsoft.Azure.Storage.Queue.CloudQueueMessage>
Public Overridable Function PeekMessages (messageCount As Integer, Optional options As QueueRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As IEnumerable(Of CloudQueueMessage)

Parameters

messageCount
Int32

The number of messages to peek. The maximum number of messages that may be retrieved at one time is 32.

options
QueueRequestOptions

A QueueRequestOptions object that specifies additional options for the request. If null, default options are applied to the request.

operationContext
OperationContext

An OperationContext object that represents the context for the current operation.

Returns

IEnumerable<CloudQueueMessage>

An enumerable collection of CloudQueueMessage objects.

Attributes

Applies to