Gemstone Data Library
Show/Hide TOC

# ITableOperationsDeleteRecordWhereAsync Method

Deletes the records referenced by the specified SQL filter expression and parameters.

## Definition

Namespace: Gemstone.Data.Model
Assembly: Gemstone.Data (in Gemstone.Data.dll) Version: 1.0.164 -- Release Build+4792d58a5dfec79a98312666bfd5a0106e818d1d
C#
View Source Request Example

    Task<int> DeleteRecordWhereAsync(
    	string filterExpression,
    	CancellationToken cancellationToken,
    	params Object?[] parameters
    )

VB
View Source Request Example

    Function DeleteRecordWhereAsync (
    	filterExpression As String,
    	cancellationToken As CancellationToken,
    	ParamArray parameters As Object()
    ) As Task(Of Integer)

C++
View Source Request Example

    Task<int>^ DeleteRecordWhereAsync(
    	String^ filterExpression,
    	CancellationToken cancellationToken,
    	... array<Object^>^ parameters
    )

JavaScript
View Source Request Example

    function DeleteRecordWhereAsync(filterExpression, cancellationToken, ... parameters);

#### Parameters

filterExpression String
  Filter SQL expression for restriction as a composite format string - does not include WHERE. When escaping is needed for field names, use standard ANSI quotes.
cancellationToken CancellationToken
  Propagates notification that operations should be canceled.
parameters Object
  Restriction parameter values.

#### Return Value

Task Int32
Number of rows affected.

## Remarks

Each indexed parameter, e.g., "{0}", in the composite format filterExpression will be converted into query parameters where each of the corresponding values in the parameters collection will be applied as IDbDataParameter values to an executed IDbCommand query.

If any of the specified 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.

If needed, field names that are escaped with standard ANSI quotes in the filter expression will be updated to reflect what is defined in the user model.

This is a convenience call to DeleteRecord(RecordRestriction, NullableBoolean).

## See Also

#### Reference

ITableOperations Interface
Gemstone.Data.Model Namespace