Data.Cloud.AzureAPI.TAzureTableService.DeleteEntity

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: function
Visibility: public
Source:
Data.Cloud.AzureAPI.pas
Data.Cloud.AzureAPI.hpp
Unit: Data.Cloud.AzureAPI
Parent: TAzureTableService

Delphi

function DeleteEntity(const TableName: string; const Entity: TCloudTableRow;
ResponseInfo: TCloudResponseInfo = nil): Boolean;

C++

bool __fastcall DeleteEntity(const System::UnicodeString TableName, Data::Cloud::Cloudapi::TCloudTableRow* const Entity, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));

Description

Deletes the given row from the specified table.

The DeleteEntity method deletes the given row from the specified table. The row must have a PartitionKey and RowKey column specified.

DeleteEntity returns True if the deletion was a success, False otherwise.

The TableName parameter specifies the name of the table to delete the row from.

The Entity parameter specifies the row to delete.

The ResponseInfo parameter specifies the optional class where to store response info.

See Also