Data.Cloud.AmazonAPI.TAmazonQueueService.CreateQueue
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 */;
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | Data.Cloud.AmazonAPI.pas Data.Cloud.AmazonAPI.hpp |
Data.Cloud.AmazonAPI | TAmazonQueueService |
Description
Creates a queue with the given name.
If the operation is successful (the queue is created), this method returns True. Otherwise, this method returns False.
CreateQueue accepts the following parameters:
QueueName: The name of the queue. Maximum length of the name is 80 characters. The characters allowed are: alphanumeric, hyphens, and underscores.QueueURL: Optional out parameter. The resulting queue's URL or an empty string, if the request fails.DefaultVisibilityTimeout: Optional. The visibility timeout (in seconds) to use for this queue. The default value is-1, which acts as a flag that means the visibility timeout for this queue is set to the default timeout of 30 seconds.Attributes: Optional. An array of TPair values. Each pair contains a TAmazonQueueAttribute and a String that holds the value for that TAmazonQueueAttribute.ResponseInfo: Optional. The class that contains the response information.