Data.Cloud.AzureAPI.TAzureQueueService.ClearMessages

• Up to Parent: TAzureQueueService

Delphi

function ClearMessages(const QueueName: string;  ResponseInfo: TCloudResponseInfo = nil): Boolean;

C++

bool __fastcall ClearMessages(const System::UnicodeString QueueName, 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

Clears the messages from the given queue.

ClearMessages clears the messages from the given QueueName.

The following table shows the significance of the parameters:

Parameter	Description
QueueName	The name of the queue to delete all messages from.
ResponseInfo	The optional class for storing response info into.

The method returns True if the operation is successful, and False otherwise.

See Also

• AddMessage

• DeleteMessage

• PeekMessages