Data.Cloud.AmazonAPI.TAmazonQueueService.GetMessagesXML

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

function GetMessagesXML(const QueueURL: string;  NumOfMessages: Integer = 0; VisibilityTimeout: Integer = -1; ResponseInfo: TCloudResponseInfo = nil): string; deprecated;

C++

System::UnicodeString __fastcall GetMessagesXML _DEPRECATED_ATTRIBUTE0 (const System::UnicodeString QueueURL, int NumOfMessages = 0x0, int VisibilityTimeout = 0xffffffff, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));

プロパティ

種類 可視性 ソース ユニット
function public
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Data.Cloud.AmazonAPI TAmazonQueueService

説明

指定されたキューからメッセージを返します。

NumOfMessages が設定されていない場合、サーバー のデフォルト値である 1 が使用されます。 設定可能な最大値は 10 です。 VisibilityTimeout が設定されていない場合、キューのデフォルト値が使用されます。 設定可能な最大値は 12 時間です。 この呼び出しによって返されるメッセージは、指定された自分の PopReceipt を持っていることに注意してください。これらは、メッセージの削除に使用することのできる、VisibilityTimeout の指定期間の間、そのメッセージに対して一意のトークンとなります。

GetMessagesXML は、メッセージの XML 表現を返します。

次の表は、各パラメータの意味を示しています:

パラメータ 説明

QueueURL

メッセージを取得してくるキューの URL。

NumOfMessages

返されるメッセージの最大数。

VisibilityTimeout

メッセージを予約する必要のある時間。

ResponseInfo

レスポンス情報を保管するための、任意のクラス。

関連項目