| title | description | author | ms.author | ms.date | ms.service | ms.subservice | ms.topic | helpviewer_keywords | apiname | apitype | |
|---|---|---|---|---|---|---|---|---|---|---|---|
ISSAsynchStatus::Abort (OLE DB driver) |
Learn how the ISSAsynchStatus::Abort method cancels an asynchronously executing operation in OLE DB Driver for SQL Server. |
David-Engel |
v-davidengel |
06/14/2018 |
sql |
connectivity |
reference |
|
ISSAsynchStatus::Abort (OLE DB) |
COM |
[!INCLUDE SQL Server]
[!INCLUDEDriver_OLEDB_Download]
Cancels an asynchronously executing operation.
HRESULT Abort(
HCHAPTER hChapter,
DBASYNCHOP eOperation);
hChapter[in]
The handle of the chapter for which to abort the operation. If the object being called isn't a rowset object or the operation doesn't apply to a chapter, the caller must set hChapter to DB_NULL_HCHAPTER.
eOperation[in]
The operation to abort. The following value should be used:
DBASYNCHOP_OPEN-The request to cancel applies to the asynchronous opening or population of a rowset or to the asynchronous initialization of a data source object.
S_OK
The request to cancel the asynchronous operation was processed. It does not guarantee that the operation itself was canceled. To determine whether the operation was canceled, the consumer should call ISSAsynchStatus::GetStatus and check for DB_E_CANCELED; however, it might not be returned in the next call.
DB_E_CANTCANCEL
The asynchronous operation cannot be canceled.
DB_E_CANCELED
The request to abort the asynchronous operation was canceled during notifications. The operation is still being executed asynchronously.
E_FAIL
A provider-specific error occurred.
E_INVALIDARG
The hChapter parameter isn't DB_NULL_HCHAPTER or eOperation isn't DBASYNCH_OPEN.
E_UNEXPECTED
ISSAsynchStatus::Abort was called on a data source object on which IDBInitialize::Initialize hasn't been called, or hasn't completed.
ISSAsynchStatus::Abort was called on a data source object on which IDBInitialize::Initialize was called but then canceled before initialization, or has timed out. The data source object is still uninitialized.
ISSAsynchStatus::Abort was called on a rowset on which ITransaction::Commit or ITransaction::Abort was previously called, and the rowset didn't survive the commit or abort and is in a zombie state.
ISSAsynchStatus::Abort was called on a rowset that was asynchronously canceled in its initialization phase. The rowset is in a zombie state.
Aborting the initialization of a rowset or data source object might leave the rowset or data source object in a zombie state, such that all methods other than IUnknown methods return E_UNEXPECTED. When this happens, the only possible action for the consumer is to release the rowset or data source object.
Calling ISSAsynchStatus::Abort and passing a value for eOperation other than DBASYNCHOP_OPEN returns S_OK. This value doesn't imply that the operation completed or was canceled.