Gemstone Data Library
Show/Hide TOC

# ITableOperationsDeleteRecordAsync(RecordRestriction, CancellationToken, NullableBoolean) Method

Deletes the records referenced by the specified restriction.

## Definition

Namespace: Gemstone.Data.Model
Assembly: Gemstone.Data (in Gemstone.Data.dll) Version: 1.0.141 -- Release Build+5f6e192e4b7ed0f35a118ae12c275adc521bb865
C#
View Source Request Example

    Task<int> DeleteRecordAsync(
    	RecordRestriction? restriction,
    	CancellationToken cancellationToken,
    	bool? applyRootQueryRestriction = null
    )

VB
View Source Request Example

    Function DeleteRecordAsync (
    	restriction As RecordRestriction,
    	cancellationToken As CancellationToken,
    	Optional applyRootQueryRestriction As Boolean? = Nothing
    ) As Task(Of Integer)

C++
View Source Request Example

    Task<int>^ DeleteRecordAsync(
    	RecordRestriction^ restriction,
    	CancellationToken cancellationToken,
    	Nullable<bool> applyRootQueryRestriction = nullptr
    )

JavaScript
View Source Request Example

    function DeleteRecordAsync(restriction, cancellationToken, applyRootQueryRestriction);

#### Parameters

restriction RecordRestriction
  Record restriction to apply
cancellationToken CancellationToken
  Propagates notification that operations should be canceled.
applyRootQueryRestriction Nullable Boolean (Optional)
  Flag that determines if any existing RootQueryRestriction should be applied. Defaults to ApplyRootQueryRestrictionToDeletes setting.

#### Return Value

Task Int32
Number of rows affected.

## Remarks

If any of the restriction parameters reference a table field that is modeled with either an EncryptDataAttribute or FieldDataTypeAttribute, then the function GetInterpretedFieldValue(String, Object) will need to be called, replacing the target parameter with the returned value so that the field value will be properly set prior to executing the database function.

## Exceptions

ArgumentNullException | restriction cannot be null.

## See Also

#### Reference

ITableOperations Interface
DeleteRecordAsync Overload
Gemstone.Data.Model Namespace