Data.Cloud.AmazonAPI.TAmazonQueueService.CreateQueue

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

Delphi

function CreateQueue(const QueueName: string; const DefaultVisibilityTimeout: Integer = -1;  ResponseInfo: TCloudResponseInfo = nil): Boolean; overload;
function CreateQueue(const QueueName: string; out QueueURL: string; const DefaultVisibilityTimeout: Integer = -1;  ResponseInfo: TCloudResponseInfo = nil): Boolean; overload;
function CreateQueue(const QueueName: string; out QueueURL: string; Attributes: array of TQueueAttributePair;  ResponseInfo: TCloudResponseInfo = nil): Boolean; overload;

C++

bool __fastcall CreateQueue(const System::UnicodeString QueueName, const int DefaultVisibilityTimeout = 0xffffffff, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall CreateQueue(const System::UnicodeString QueueName, /* out */ System::UnicodeString &QueueURL, const int DefaultVisibilityTimeout = 0xffffffff, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall CreateQueue(const System::UnicodeString QueueName, /* out */ System::UnicodeString &QueueURL, System::Generics::Collections::TPair__2<TAmazonQueueAttribute,System::UnicodeString> *Attributes, const int Attributes_High, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;

プロパティ

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


説明

指定された名前でキューを作成します。

オペレーションが成功した(キューが作成された)場合、このメソッドは True を返します。そうでなければ、このメソッドは False を返します。

CreateQueue は、次のパラメータを取ります:

  • QueueName: キューの名前。名前の最大長は 80 文字です。有効な文字: アルファベット、ハイフン、アンダースコア。
  • QueueURL: 出力パラメータ(省略可能)。結果のキューの URL または空の文字列(リクエストが失敗した場合)。
  • DefaultVisibilityTimeout: 省略可能。このキューに使用される表示のタイムアウト(ミリ秒)。デフォルト値は -1 で、このキューの表示タイムアウトが、デフォルトのタイムアウトの 30 秒に設定されていることを意味する、フラグとして動作します。
  • Attributes: 省略可能。TPair 値の配列。各ペアは、TAmazonQueueAttribute と、その TAmazonQueueAttribute の値を保有する文字列を含んでいます。
  • ResponseInfo: 省略可能。 レスポンスの情報を保有するクラス。

関連項目