Data.Cloud.AzureAPI.TAzureQueueService.DeleteMessage
Delphi
function DeleteMessage(const QueueName: string; const MessageId: string; const PopReceipt: string;
ResponseInfo: TCloudResponseInfo = nil): Boolean; overload;
function DeleteMessage(const QueueName: string; const QueueMessage: TCloudQueueMessage;
GetPopReceiptIfNeeded: Boolean = True;
ResponseInfo: TCloudResponseInfo = nil): Boolean; overload;
C++
bool __fastcall DeleteMessage(const System::UnicodeString QueueName, const System::UnicodeString MessageId, const System::UnicodeString PopReceipt, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall DeleteMessage(const System::UnicodeString QueueName, Data::Cloud::Cloudapi::TCloudQueueMessage* const QueueMessage, bool GetPopReceiptIfNeeded = true, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | Data.Cloud.AzureAPI.pas Data.Cloud.AzureAPI.hpp |
Data.Cloud.AzureAPI | TAzureQueueService |
説明
渡されたメッセージを指定されたキューから削除します。
DeleteMessage にはオーバーロード メソッドが 2 つあります。
次の表に、オーバーロードされた両方のメソッドのパラメータの意味を示します。
| パラメータ | 説明 |
|---|---|
|
QueueName |
メッセージを削除するキューの名前。 |
|
MessageId |
削除するメッセージの一意の ID。 |
|
PopReceipt |
メッセージを削除するために必要な pop 受信体。 |
|
QueueMessage |
削除するメッセージ。 |
|
GetPopReceiptIfNeeded |
True（デフォルト）に設定すると、メッセージの pop 受信体をまだ持っていない場合に、取得しようとします。 |
|
ResponseInfo |
レスポンス情報を格納する任意のクラス。 |
GetPopReceiptIfNeeded が True（デフォルト）に設定されている場合、そして、
メッセージ オブジェクトで空の文字列が pop 受信体に設定されている場合、pop 受信体が、最初の GetMessages の呼び出しで取得されます。その際、メッセージ数と表示タイムアウトには、デフォルト値が使用されます。削除要求のメッセージが、キューの一番上でなかった場合、削除は失敗します。
メソッドは、削除が成功したら True を、そうでなければ False を返します。