transferComplete

  • Article

Indicates that a data transfer is complete. All providers must invoke this event. transferComplete is an event handler method, implemented through OLEDBSimpleProvider::addOLEDBSimpleProviderListener. All asynchronous providers must call this function when a transfer of data is complete.

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 transferComplete (
   OSPXFER   doneReason);

Parameters

  • doneReason
    [in] Supports the values defined in the following table.

    Value

    Meaning

    OSPXFER_COMPLETE = 0

    Data transmission completed successfully.

    OSPXFER_ABORT = 1

    Data transmission completed because of a call to the Stop method.

    OSPXFER_ERROR = 2

    Data transmission completed in an error state.

Return Codes

  • S_OK
    The method succeeded.

  • E_FAIL
    A provider-specific error occurred.

Comments

For providers that retrieve their data asynchronously, this event signifies that no additional OLEDBSimpleProviderListener::rowsAvailable events will be called for this data set.