IDbCommandInterceptor.CommandCanceledAsync Method

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Diagnostics

Assembly:: Microsoft.EntityFrameworkCore.Relational.dll

Package:: Microsoft.EntityFrameworkCore.Relational v7.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v8.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v9.0.0

Source:: IDbCommandInterceptor.cs

Source:: IDbCommandInterceptor.cs

Source:: IDbCommandInterceptor.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Called when a command was canceled.

public virtual System.Threading.Tasks.Task CommandCanceledAsync (System.Data.Common.DbCommand command, Microsoft.EntityFrameworkCore.Diagnostics.CommandEndEventData eventData, System.Threading.CancellationToken cancellationToken = default);

abstract member CommandCanceledAsync : System.Data.Common.DbCommand * Microsoft.EntityFrameworkCore.Diagnostics.CommandEndEventData * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CommandCanceledAsync : System.Data.Common.DbCommand * Microsoft.EntityFrameworkCore.Diagnostics.CommandEndEventData * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function CommandCanceledAsync (command As DbCommand, eventData As CommandEndEventData, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

command: DbCommand

The command.

eventData: CommandEndEventData

Contextual information about the command and execution.

cancellationToken: CancellationToken

A CancellationToken to observe while waiting for the task to complete.

Returns

Task

A Task representing the asynchronous operation.

Exceptions

OperationCanceledException

If the CancellationToken is canceled.

Applies to

Share via