ADO Cancel Method
Applies To:
Command Object (ADO)
Connection Object (ADO)
Record Object (ADO)
Recordset Object (ADO)
Stream Object (ADO)
The Cancel method cancels an execution of a pending Execute call.
The Cancel method is used to cancel the last pending, asynchronous
call involving the Execute method of the Command object.
The Options parameter of the Execute method must be set to either
the adAsyncExecute or adAsyncFetch constant. Otherwise, a run-time
error will be generated.
An asynchronous call returns control to the calling program before the operation
is completed and allows the execution of the code to continue.
The Cancel method cancels different tasks for each object. The table below
shows what task is cancelled when this method is called:
| Object |
Cancelled task |
| Command |
Execute.
Note: The Options parameter of the Execute method must be set
to adAsyncExecute or adAsyncFetch, before the Cancel method is called,
otherwise a run-time error will occur |
| Connection |
Execute or Open.
Note: The Options parameter of the Open method must be set to
adSyncConnect, or the Options parameter of the Execute method be set to
adAsyncExecute or adAsyncFetch, before the Cancel method is called,
otherwise a run-time error will occur |
| Record |
CopyRecord, DeleteRecord, MoveRecord, or Open
Note: The Options parameter of the Execute method must be set
to adAsyncExecute or adAsyncFetch, before the Cancel method is called,
otherwise a run-time error will occur |
| Recordset |
Open
|
| Stream |
Open
|
Syntax
Examples
If (objCommand.State = adStateFetching) Then
objCommand.Cancel
End If
'OR
objRecordset.Open strQuery, , , adCmdTable
...
objRecordset.Cancel
'OR
objStream.Cancel
|
|