Data.Cloud.AmazonAPI.TAmazonQueueService.DeleteMessage

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 DeleteMessage(const QueueURL: string; const PopReceipt: string;
ResponseInfo: TCloudResponseInfo = nil): Boolean;

C++

bool __fastcall DeleteMessage(const System::UnicodeString QueueURL, const System::UnicodeString PopReceipt, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));

Description

Deletes the given message from the specified queue.

Use DeleteMessage to delete the given message from the specified queue.

The method returns True if the deletion was successful, False otherwise.

The following table shows the significance of the parameters:

Parameter Description

QueueURL

URL of the queue to delete a message from.

PopReceipt

The pop receipt required for deleting the message.

ResponseInfo

The optional class for storing response info into.


See Also