Data.Cloud.AzureAPI.TAzureQueueService.PeekMessagesXML
Delphi
function PeekMessagesXML(const QueueName: string; NumOfMessages: Integer; ResponseInfo: TCloudResponseInfo = nil): string;
C++
System::UnicodeString __fastcall PeekMessagesXML(const System::UnicodeString QueueName, int NumOfMessages, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | Data.Cloud.AzureAPI.pas Data.Cloud.AzureAPI.hpp |
Data.Cloud.AzureAPI | TAzureQueueService |
説明
指定されたキューからメッセージを、XML 表現で返します。
PeekMessagesXML を使用すると、それらの Data.Cloud.CloudAPI.TCloudQueueMessage.PopReceipt を指定することなしに、指定されたキューからメッセージを取得することができます。 このメソッドは、結果を XML 表現で返します。
次の表は、各パラメータの意味を示しています：
| パラメータ | 説明 |
|---|---|
|
QueueName |
メッセージを取得してくるキューの名前。 |
|
NumOfMessages |
返されるメッセージの最大数。 |
|
ResponseInfo |
レスポンス情報を保管するための、任意のクラス。 |
NumOfMessages が設定されていない場合、サーバー のデフォルト値である 1 が使用されます。 設定可能な最大値は 32 です。
この呼び出しによって返されるメッセージは、Data.Cloud.CloudAPI.TCloudQueueMessage.PopReceipt が指定されていない点に留意してください。 VisibilityTimeout がないため、他のユーザーが簡単にメッセージにクエリをかけ、参照することができます。