stopTransfer

  • Article

Requests that the simple provider discontinue the asynchronous transfer of data.

Important

This feature will be removed in a future version of Windows. Avoid using this feature in new development work, and plan to modify applications that currently use this feature. Instead, write a fully functional OLE DB provider using the native OLE DB interfaces.

Syntax

HRESULT stopTransfer ( );

Return Codes

  • S_OK
    The method succeeded.

  • E_FAIL
    A provider-specific error occurred, or the OSP was unable to stop the asynchronous transfer.

Comments

Providers should make every effort to expose the data transferred prior to receiving this request. The provider must expose a valid, consistent OSP interface for such data, including an appropriate count of the columns and rows and the read/write status.

Providers that cannot expose the data prior to receiving this request should discontinue the transfer of data and fail all subsequent calls to the OSP interface.

OLEDBSimpleProvider::stopTransfer requires the OLEDBSimpleProviderListener::transferComplete notification if provider data will populate the consumer application or control asynchronously.