Data.Cloud.AmazonAPI.TAmazonQueueService.GetQueuePropertiesXML

From RAD Studio API Documentation
Jump to: navigation, search

Delphi 

function GetQueuePropertiesXML(const QueueURL: string; Attribute: TAmazonQueueAttribute = aqaAll;  ResponseInfo: TCloudResponseInfo = nil): string; overload; deprecated;
function GetQueuePropertiesXML(const QueueURL: string; Attributes: array of TAmazonQueueAttribute;  ResponseInfo: TCloudResponseInfo = nil): string; overload; deprecated;

C++ 

System::UnicodeString __fastcall GetQueuePropertiesXML _DEPRECATED_ATTRIBUTE0 (const System::UnicodeString QueueURL, TAmazonQueueAttribute Attribute = (TAmazonQueueAttribute)(0x0), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
System::UnicodeString __fastcall GetQueuePropertiesXML _DEPRECATED_ATTRIBUTE0 (const System::UnicodeString QueueURL, TAmazonQueueAttribute *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

Returns one or all properties for the specified queue.

There are two GetQueuePropertiesXML overloaded methods:

  • The first one returns the XML representation for either one or all properties of the given queue.
  • The second one returns the XML representation for either one or more properties of the given queue. Also, if you pass an empty array, then all attributes are returned.

The attributes specified will be the property returned by this call. If you specify 'All' as an attribute to return, then all properties of the queue will be returned.

Note: For the second overloaded method, the Attribute parameter is an array of TAmazonQueueAttribute.

The following table shows the significance of the parameters:

Parameter Description

QueueURL

The URL of the queue to get the attributes for.

Attribute

The attribute (or 'All') to get.

ResponseInfo

The optional class for storing response info into.

See Also

Retrieved from "http://docwiki.embarcadero.com/Libraries/Rio/e/index.php?title=Data.Cloud.AmazonAPI.TAmazonQueueService.GetQueuePropertiesXML&oldid=158121"