Data.Cloud.AmazonAPI.TAmazonQueueService.ReceiveMessage

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 ReceiveMessage(const AQueueURL: string; ANumOfMessages: Integer; AVisibilityTimeout: Integer;
out AResponseXML: string; const AResponseInfo: TCloudResponseInfo): TArray<TCloudQueueMessageItem>;

C++

System::DynamicArray<Data::Cloud::Cloudapi::TCloudQueueMessageItem> __fastcall ReceiveMessage(const System::UnicodeString AQueueURL, int ANumOfMessages, int AVisibilityTimeout, /* out */ System::UnicodeString &AResponseXML, Data::Cloud::Cloudapi::TCloudResponseInfo* const AResponseInfo);

Description

Returns messages from the given queue.

The maximum ANumOfMessages allowed value is 10. The maximum AVisibilityTimeout allowed value is 12 hours. Note that messages returned by this call will have their PopReceipt specified, which is a unique token for message during the VisibilityTimeout and can be used to delete the message.