Data.Win.ADODB.TADOCommand.Cancel

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure Cancel;

C++

void __fastcall Cancel();

Properties

Type Visibility Source Unit Parent
procedure
function
public
Data.Win.ADODB.pas
Data.Win.ADODB.hpp
Data.Win.ADODB TADOCommand

Description

Halts execution of an ADO command.

Call Cancel abort the execution of a command executed by the command component. To use Cancel to abort a command, the command by have been executed asynchronously (the eoAsyncExecute TExecuteOption must have been used). If the command is not asynchronous an exception is raised. Use the command component's ExecuteOptions to specify that a command is executed asynchronously.

Note: To successfully cancel a command, Cancel must be called before the number of seconds specified in CommandTimeout have expired.

See Also