QueueClient.PeekMessages(Nullable<Int32>, CancellationToken) メソッド

定義

名前空間:

Azure.Storage.Queues

アセンブリ:

Azure.Storage.Queues.dll

パッケージ:

Azure.Storage.Queues v12.18.0

ソース:

QueueClient.cs

キューの先頭から 1 つ以上のメッセージを取得しますが、メッセージの可視性は変更しません。

詳細については、「 [メッセージのピーク] を選択します。

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())

パラメーター

maxMessages

Nullable<Int32>

任意。 キューから表示するメッセージの数を示すゼロ以外の整数値を指定します (上限は 32 件)。 既定では、この操作でキューから 1 件のメッセージが表示されます。

cancellationToken

CancellationToken

オプション CancellationToken

戻り値

Response<PeekedMessage[]>

Response<T> ここで、T は の配列です PeekedMessage