TableOperationsTDeleteRecordAsync(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.166 -- Release Build+4734116ef9caa0a1e84bf70b15935e09ea790ab3

C#View Source Request Example

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

VBView Source Request Example

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

C++View Source Request Example

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

JavaScriptView 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 NullableBoolean (Optional): Flag that determines if any existing RootQueryRestriction should be applied. Defaults to ApplyRootQueryRestrictionToDeletes setting.

Return Value

TaskInt32
Number of rows affected.

Implements

ITableOperationsDeleteRecordAsync(RecordRestriction, CancellationToken, NullableBoolean)

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.