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 */;
Propriétés
| Type | Visibilité | Source | Unité | Parent |
|---|---|---|---|---|
| function | public | Data.Cloud.AzureAPI.pas Data.Cloud.AzureAPI.hpp |
Data.Cloud.AzureAPI | TAzureQueueService |
Description
Supprime le message donné de la file d'attente spécifiée.
Il existe deux méthodes surchargées DeleteMessage.
Le tableau suivant indique la signification des paramètres pour les deux méthodes surchargées :
| Paramètre | Description |
|---|---|
|
QueueName |
Le nom de la file d'attente sur laquelle supprimer le message. |
|
MessageId |
L'ID unique du message à supprimer. |
|
PopReceipt |
La réception POP requise pour la suppression du message. |
|
QueueMessage |
Le message à supprimer. |
|
GetPopReceiptIfNeeded |
Définissez sur True (valeur par défaut) pour tenter d'obtenir une réception POP pour le message s'il n'en détient pas déjà une. |
|
ResponseInfo |
La classe optionnelle dans laquelle stocker les informations de la réponse. |
Si GetPopReceiptIfNeeded est défini sur True (valeur par défaut) et si l'objet message a une chaîne vide définie en tant que sa réception POP, une réception POP est obtenue par l'appel de GetMessages avec les valeurs par défaut pour le nombre de messages et le délai d'attente de la visibilité. Si le message demandant la suppression ne se trouve pas en haut de la file d'attente, la suppression échoue.
La méthode renvoie True si la suppression réussit, et False sinon.