Data.Cloud.AzureAPI.TAzureQueueService.DeleteQueue

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function DeleteQueue(const QueueName: string; ResponseInfo: TCloudResponseInfo = nil): Boolean;

C++

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

Properties

Type Visibility Source Unit Parent
function public
Data.Cloud.AzureAPI.pas
Data.Cloud.AzureAPI.hpp
Data.Cloud.AzureAPI TAzureQueueService

Description

Deletes the queue with the given name.

Using DeleteQueue, the queue is marked for deletion and will not show up in queries, but there will be a short time before the server allows another queue with the same name to be created again.

The following table shows the significance of the parameters:

Parameter Description

QueueName

The name of the queue to delete.

ResponseInfo

The optional class for storing response info into.

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

See Also