Udostępnij za pośrednictwem

QueueClient.PeekMessages(Nullable<Int32>, CancellationToken) Method

  • Reference

Definition

Namespace:
Azure.Storage.Queues
Assembly:
Azure.Storage.Queues.dll
Package:
Azure.Storage.Queues v12.21.0
Package:
Azure.Storage.Queues v12.21.0-beta.2
Source:
QueueClient.cs
Source:
QueueClient.cs

Retrieves one or more messages from the front of the queue but does not alter the visibility of the message.

For more information, see Peek Messages.

public virtual Azure.Response<Azure.Storage.Queues.Models.PeekedMessage[]> PeekMessages (int? maxMessages = default, System.Threading.CancellationToken cancellationToken = default);
abstract member PeekMessages : Nullable<int> * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Queues.Models.PeekedMessage[]>
override this.PeekMessages : Nullable<int> * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Queues.Models.PeekedMessage[]>
Public Overridable Function PeekMessages (Optional maxMessages As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of PeekedMessage())

Parameters

maxMessages
Nullable<Int32>

Optional. A nonzero integer value that specifies the number of messages to peek from the queue, up to a maximum of 32. By default, a single message is peeked from the queue with this operation.

cancellationToken
CancellationToken

Optional CancellationToken

Returns

Response<PeekedMessage[]>

Response<T> where T is an array of PeekedMessage

Applies to