From RAD Studio API Documentation
Jump to: navigation, search


function PeekMessages(const QueueURL: string; NumOfMessages: Integer;  ResponseInfo: TCloudResponseInfo = nil): TList<TCloudQueueMessage>; deprecated;


System::Generics::Collections::TList__1<Data::Cloud::Cloudapi::TCloudQueueMessage*>* __fastcall PeekMessages _DEPRECATED_ATTRIBUTE0 (const System::UnicodeString QueueURL, int NumOfMessages, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));


Type Visibility Source Unit Parent
function public
Data.Cloud.AmazonAPI TAmazonQueueService


Warning: PeekMessages is deprecated. Please use ReceiveMessage.

Retrieves a list of messages from a queue.

This method accepts the following parameters:

  • QueueURL: The URL of the queue.
  • NumOfMessages: The maximum number of messages that you want to retrieve. The allowed values for NumOfMessages are 1 - 10.
  • ResponseInfo: Optional. The class that stores the response information.

This method returns a list of messages. These messages do not have the PopReceipt value specified.

PeekMessages is similar to GetMessages. The main difference is that PeekMessages does not hide the messages from other requests. You can achieve the same result if you pass 0 as VisibilityTimeout parameter to GetMessages.

See Also