Data.Cloud.AzureAPI.TAzureQueueService.GetMessages
Delphi
function GetMessages(const QueueName: string; NumOfMessages: Integer = 0; VisibilityTimeout: Integer = 0; ResponseInfo: TCloudResponseInfo = nil): TList<TCloudQueueMessage>;
C++
System::Generics::Collections::TList__1<Data::Cloud::Cloudapi::TCloudQueueMessage*>* __fastcall GetMessages(const System::UnicodeString QueueName, int NumOfMessages = 0x0, int VisibilityTimeout = 0x0, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | Data.Cloud.AzureAPI.pas Data.Cloud.AzureAPI.hpp |
Data.Cloud.AzureAPI | TAzureQueueService |
説明
渡されたキューからメッセージを返します。
GetMessages を使用すると、渡されたキューからメッセージを取得します。
次の表は、パラメータの意味を表しています：
| パラメータ | 説明 |
|---|---|
|
QueueName |
メッセージを取得するキューの名前。 |
|
NumOfMessages |
返すメッセージの最大数。 |
|
VisibilityTimeout |
メッセージを予約する期間。 |
|
ResponseInfo |
レスポンス情報を格納する任意のクラス。 |
NumOfMessages が設定されていない場合、サーバー デフォルトの 1 が使用されます。使用可能な最大値は 32 です。
VisibilityTimeout が設定されていない場合、サーバー デフォルトの 30 秒が使用されます。 使用可能な最大値は 2 時間です。
この呼び出しによって返されるメッセージは、指定された自分自身の Data.Cloud.CloudAPI.TCloudQueueMessage.PopReceipt を持っており、VisibilityTimeout 期間、メッセージの削除に使用できるメッセージを一意に決定するトークンです。VisibilityTimeout の間、メッセージはさらなるメッセージの問い合わせから隠ぺいされます。
メソッドは、メッセージのリストを、詰められた pop 受信体と共に返します。