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));
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
function | public | Data.Cloud.AzureAPI.pas Data.Cloud.AzureAPI.hpp |
Data.Cloud.AzureAPI | TAzureQueueService |
説明
指定されたキューへメッセージを追加します。
AddMessage は、指定された QueueName
へ、メッセージを追加します。
次の表は、各パラメータの意味を示しています:
パラメータ | 説明 |
---|---|
QueueName |
メッセージが追加されるキュー。 |
MessageText |
メッセージのテキスト。 |
TimeToLive |
メッセージが期限切れになるまでの時間(秒)、または、サーバーのデフォルト値を使用する場合には 0。 |
ResponseInfo |
レスポンス情報を保管するための、任意のクラス。 |
TimeToLive
パラメータが、0 より大きい数字に設定されている場合、それは、期限切れになるまでにメッセージがキュー内にいられる時間を秒数で表しています。最大は 7 日間です(デフォルト値)。
このメソッドは、メッセージの追加に成功した場合には True を、そうでない場合には False を返します。