FireDAC.Comp.Script.TFDScript.AbortJob
Delphi
procedure AbortJob(const AWait: Boolean = False);
C++
void __fastcall AbortJob(const bool AWait = false);
Properties
Type | Visibility | Source | Unit | Parent |
---|---|---|---|---|
procedure function |
public | FireDAC.Comp.Script.pas FireDAC.Comp.Script.hpp |
FireDAC.Comp.Script | TFDScript |
Description
Aborts the script validation or execution.
Parameters | Description |
---|---|
const AWait: Boolean = False |
True, if the method should wait for a DBMS query cancelation. |
Call the AbortJob method to abort the script:
- Validation, run by the ValidateStep or ValidateAll method calls.
- Execution, run by the ExecuteStep or ExecuteAll method calls.
This method also aborts any DBMS query launched by the script execution.
If AWait
is True, then AbortJob waits until a DBMS query finishes its processing. After the method call, the Status property is equal to ssAborted
and the Finished property is True. The method also aborts all nested script calls.