Data.Cloud.AmazonAPI.TAmazonQueueService.GetMessagesXML
Delphi
function GetMessagesXML(const QueueURL: string; NumOfMessages: Integer = 0; VisibilityTimeout: Integer = -1; ResponseInfo: TCloudResponseInfo = nil): string;
C++
System::UnicodeString __fastcall GetMessagesXML(const System::UnicodeString QueueURL, int NumOfMessages = 0x0, int VisibilityTimeout = 0xffffffff, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | Data.Cloud.AmazonAPI.pas Data.Cloud.AmazonAPI.hpp |
Data.Cloud.AmazonAPI | TAmazonQueueService |
Description
Returns messages from the given queue.
If NumOfMessages is not set, then the server default of 1 is used. The maximum allowed value is 10. If VisibilityTimeout is not set, the queue's default is used. The maximum allowed value is 12 hours. Note that messages returned by this call will have their PopReceipt specified, which is a token unique to the message during the VisibilityTimeout that can be used to delete the message.
The GetMessagesXML returns the XML representation of the messages.
The following table shows the significance of the parameters:
| Parameter | Description |
|---|---|
|
|
The URL of the queue to get the messages for. |
|
|
The maximum number of messages to return. |
|
|
The time for which the messages should be reserved. |
|
|
The optional class for storing response info into. |