Data.Cloud.AzureAPI.TAzureQueueService.AddMessage
Delphi
function AddMessage(const QueueName: string; const MessageText: string; const TimeToLive: Integer = 0; ResponseInfo: TCloudResponseInfo = nil): Boolean;
C++
bool __fastcall AddMessage(const System::UnicodeString QueueName, const System::UnicodeString MessageText, const int TimeToLive = 0x0, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));
Properties
Type | Visibility | Source | Unit | Parent |
---|---|---|---|---|
function | public | Data.Cloud.AzureAPI.pas Data.Cloud.AzureAPI.hpp |
Data.Cloud.AzureAPI | TAzureQueueService |
Description
Adds a message to the given queue.
AddMessage adds a message to the given QueueName
.
The following table shows the significance of the parameters:
Parameter | Description |
---|---|
QueueName |
The queue to add the message to. |
MessageText |
The text of the message. |
TimeToLive |
The time in seconds before the message expires, or 0 to use the server default value. |
ResponseInfo |
The optional class for storing response info into. |
The TimeToLive
parameter, if set to something greater than 0, specifies the time in seconds to leave the message in the queue before expiring it. The maximum (and default) is 7 days.
The method returns True if the message was added successfully, and False otherwise.