Edit

IDataObjectAsyncCapability::EndOperation method (shldisp.h)

  • Article

Notifies the data object that the asynchronous data extraction has ended.

Syntax

HRESULT EndOperation(
  [in] HRESULT  hResult,
  [in] IBindCtx *pbcReserved,
  [in] DWORD    dwEffects
);

Parameters

[in] hResult

Type: HRESULT

Indicates the outcome of the data extraction. Set this value to S_OK if successful, or a COM error code otherwise.

[in] pbcReserved

Type: IBindCtx*

Reserved. Set to nullptr.

[in] dwEffects

Type: DWORD

A DROPEFFECT value that indicates the result of an optimized move. This should be the same value that would be passed to the data object as a CFSTR_PERFORMEDDROPEFFECT format with a normal data extraction operation.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

EndOperation retrieves the IDataObjectAsyncCapability pointer stored by IDataObjectAsyncCapability::SetAsyncMode and passes its parameter values to that interface's IDataObjectAsyncCapability::EndOperation method. EndOperation then releases the IDataObjectAsyncCapability pointer.

EndOperation is also responsible for any associated clean-up operations. When finished, EndOperation should notify the drop source through a private interface.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header shldisp.h
DLL Shell32.dll (version 6.0 or later)

See also

IDataObjectAsyncCapability