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 */;
Eigenschaften
| Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
|---|---|---|---|---|
| function | public | Data.Cloud.AzureAPI.pas Data.Cloud.AzureAPI.hpp |
Data.Cloud.AzureAPI | TAzureQueueService |
Beschreibung
Löscht die angegebene Nachricht aus der angegebenen Queue.
Es gibt zwei überladene Methoden DeleteMessage.
Die folgende Tabelle gibt die Bedeutung der Parameter für die beiden überladenen Methoden an:
| Parameter | Beschreibung |
|---|---|
|
QueueName |
Der Name der Queue, aus der eine Nachricht entfernt werden soll |
|
MessageId |
Die eindeutige ID der zu löschenden Nachricht |
|
PopReceipt |
Der Pop-Empfang, der zum Löschen der Nachricht erforderlich ist |
|
QueueMessage |
Die zu löschende Nachricht |
|
GetPopReceiptIfNeeded |
Wird auf True (Vorgabewert) gesetzt, um einen Pop-Empfang für die Nachricht zu ermitteln, wenn noch keiner vorhanden ist. |
|
ResponseInfo |
Die optionale Klasse zum Speichern der Antwortinformationen |
Wenn GetPopReceiptIfNeeded auf True (Vorgabewert) gesetzt ist und das Nachrichtenobjekt einen leeren String als Pop-Empfang enthält, dann wird ein Pop-Empfang abgerufen, indem zuerst GetMessages mit den Standardwerten für die Anzahl der Nachrichten und die Zeitüberschreitung der Sichtbarkeit aufgerufen wird. Wenn sich die zu löschende Nachricht nicht oben in der Queue befindet, schlägt das Löschen fehl.
Die Methode gibt True zurück, wenn das Löschen erfolgreich war, ansonsten False.