Data.Cloud.AzureAPI.TAzureQueueService.PeekMessages
| [–] Properties | |
|---|---|
| Type: function | |
| Visibility: public | |
| Source: Data.Cloud.AzureAPI.pas Data.Cloud.AzureAPI.hpp
| |
| Unit: Data.Cloud.AzureAPI | |
| Parent: TAzureQueueService | |
Delphi
function PeekMessages(const QueueName: string; NumOfMessages: Integer;
ResponseInfo: TCloudResponseInfo = nil): TList<TCloudQueueMessage>;
C++
System::Generics::Collections::TList__1<Data::Cloud::Cloudapi::TCloudQueueMessage*>* __fastcall PeekMessages(const System::UnicodeString QueueName, int NumOfMessages, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));
Description
Returns messages from the given queue.
Use PeekMessages to get messages from the given queue without their Data.Cloud.CloudAPI.TCloudQueueMessage.PopReceipt specified.
The following table shows the significance of the parameters:
| Parameter | Description |
|---|---|
|
QueueName |
The name of the queue to get the messages for. |
|
NumOfMessages |
The maximum number of messages to return. |
|
ResponseInfo |
The optional class for storing response info into. |
If NumOfMessages is not set, then the server default of 1 is used. The maximum allowed value is 32.
Note that messages returned by this call will not have their Data.Cloud.CloudAPI.TCloudQueueMessage.PopReceipt specified. There is no VisibilityTimeout, so other users can instantly query messages and see them.