Data.Cloud.AzureAPI.TAzureQueueService.CreateQueue

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: function
Visibility: public
Source:
Data.Cloud.AzureAPI.pas
Data.Cloud.AzureAPI.hpp
Unit: Data.Cloud.AzureAPI
Parent: TAzureQueueService

Delphi

function CreateQueue(const QueueName: string; const MetaDataHeaders: TStrings = nil;
ResponseInfo: TCloudResponseInfo = nil): Boolean;

C++

bool __fastcall CreateQueue(const System::UnicodeString QueueName, System::Classes::TStrings* const MetaDataHeaders = (System::Classes::TStrings*)(0x0), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));

Description

Creates a queue with the given name and metadata.

CreateQueue creates a queue with the given QueueName queue and MetaDataHeaders metadata. If metadata is specified, it will be set as the metadata associated with the queue.

The following table shows the significance of the parameters:

Parameter Description

QueueName

The name of the queue to create.

MetaDataHeaders

The header name/value pairs to associate with the queue.

ResponseInfo

The optional class for storing response info into.

The method returns True if the operation was successful, and False otherwise.

See Also