Data.Cloud.AzureAPI.TAzureQueueService.GetQueueMetadata

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

C++

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

Description

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

GetQueueMetadata gets 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 get the metadata for.

MetaData

The returned metadata, or nil if the call fails.

ResponseInfo

The optional class for storing response info into.

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

See Also