Data.Cloud.AmazonAPI.TAmazonTableService.DeleteColumns

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function DeleteColumns(const TableName, RowId: string; const Columns: TStrings;  Conditionals: TList<TAmazonRowConditional>; ResponseInfo: TCloudResponseInfo = nil): Boolean; overload;
function DeleteColumns(const TableName, RowId: string; const Columns: TStrings;  ResponseInfo: TCloudResponseInfo = nil): Boolean; overload;

C++

bool __fastcall DeleteColumns(const System::UnicodeString TableName, const System::UnicodeString RowId, System::Classes::TStrings* const Columns, System::Generics::Collections::TList__1<TAmazonRowConditional>* Conditionals, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall DeleteColumns(const System::UnicodeString TableName, const System::UnicodeString RowId, System::Classes::TStrings* const Columns, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;

Properties

Type Visibility Source Unit Parent
function public
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Data.Cloud.AmazonAPI TAmazonTableService

Description

Deletes the specified columns from the given row.

There are two DeleteColumns overloaded methods.

For the first one you can customize the request through the Conditionals parameter. The optional Conditionals specify the conditions when the deletion should happen, and when it should not. For more information, see the documentation for TAmazonRowConditional.

If no columns are specified, then the row is deleted.

Each item in the list can be either a column name or a delimiter pair of column name and column value.

DeleteColumns returns True if the deletion terminates without an exception being thrown, and False otherwise.

The following table shows the significance of the parameters:

Parameter Description

TableName

The name of the table the row is in.

RowId

The row to delete columns from (or the row to delete, if no columns are specified).

Columns

The columns to delete, or nil or an empty list to delete the row.

Conditionals

The optional conditionals to be met for the deletion to happen.

ResponseInfo

The optional class for storing response info into.

See Also