Data.Cloud.AzureAPI.TAzureQueueService.SetQueueMetadata

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 SetQueueMetadata(const QueueName: string; const MetaData: TStrings;
ResponseInfo: TCloudResponseInfo = nil): Boolean;

C++

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

Description

Sets the metadata name/value pairs associated with the given queue.

SetQueueMetadata is used to set the metadata name/value pairs associated with the given queue.

The following table shows the significance of the parameters:

Parameter Description

QueueName

The name of the queue to set the metadata for.

MetaData

The metadata to set for the queue.

ResponseInfo

The optional class for storing response info into.

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

See Also