DSAzure.TAzureQueueService.GetMessages
Delphi
function GetMessages(const QueueName: String; NumOfMessages: Integer = 0; VisibilityTimeout: Integer = 0): String;
C++
System::UnicodeString __fastcall GetMessages(const System::UnicodeString QueueName, int NumOfMessages = 0x0, int VisibilityTimeout = 0x0);
Properties
Type | Visibility | Source | Unit | Parent |
---|---|---|---|---|
function | public | DSAzure.pas DSAzure.hpp |
DSAzure | TAzureQueueService |
Description
Retrieves and temporarily hides queue messages.
GetMessages returns an XML string of all of the retrieved messages. The number of messages retrieved is controlled by the value of NumOfMessages
and the time duration they remain hidden after retrieving them is controlled by VisibilityTimeout
. During this period you can use the pop receipt, which is provided for each returned message; use that to delete the corresponding message by calling DeleteMessage.
For more information, refer to the MSDN documentation and Microsoft Azure Queue API page in the See Also section.