Data.Cloud.AzureAPI.TAzureQueueService.GetMessagesXML
Delphi
function GetMessagesXML(const QueueName: string; NumOfMessages: Integer = 0; VisibilityTimeout: Integer = 0; ResponseInfo: TCloudResponseInfo = nil): string;
C++
System::UnicodeString __fastcall GetMessagesXML(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 |
説明
メッセージの XML 表現を返します。
GetMessagesXML を使用すると、指定されたキューからメッセージの XML 表現を取得することができます。
次の表は、各パラメータの意味を示しています：
| パラメータ | 説明 |
|---|---|
|
QueueName |
メッセージを取得してくるキューの名前。 |
|
NumOfMessages |
返されるメッセージの最大数。 |
|
VisibilityTimeout |
メッセージが予約される時間。 |
|
ResponseInfo |
レスポンス情報を保管するための、任意のクラス。 |
NumOfMessages が設定されていない場合、サーバー のデフォルト値である 1 が使用されます。 設定可能な最大値は 32 です。
VisibilityTimeout が設定されていない場合、サーバー のデフォルト値である 30 秒が使用されます。 設定可能な最大値は 2 時間です。
この呼び出しによって返されるメッセージは、指定された自分の Data.Cloud.CloudAPI.TCloudQueueMessage.PopReceipt を持っていることに注意してください。これらは、メッセージの削除に使用することのできる、VisibilityTimeout の指定期間の間、そのメッセージに対して一意のトークンとなります。