Data.Cloud.AmazonAPI.TAmazonQueueService.PurgeQueue

From RAD Studio API Documentation
Jump to: navigation, search

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

Delphi

function PurgeQueue(const AQueueURL: string; const AResponseInfo: TCloudResponseInfo): Boolean;

C++

bool __fastcall PurgeQueue(const System::UnicodeString AQueueURL, Data::Cloud::Cloudapi::TCloudResponseInfo* const AResponseInfo);

Description

Deletes the messages that match the specified queue URL and returns True on success or False otherwise.

AResponseInfo is an instance of TCloudResponseInfo to store the information of the response. Use a nil value if you do not need the information of the response.

See Also