IAsyncOperation::EndOperation method

  • 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

  • hResult [in]
    Type: HRESULT

    An HRESULT value that indicates the outcome of the data extraction. Set to S_OK if successful, or a COM error code otherwise.

  • pbcReserved [in]
    Type: IBindCtx*

    Reserved. Set to NULL.

  • dwEffects [in]
    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

Returns S_OK if successful or a COM error value otherwise.

Remarks

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

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

Requirements

Minimum supported client

Windows 2000 Professional, Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

 Shldisp.h

IDL

 Shldisp.idl

DLL

 Shell32.dll (version 5.0 or later)

See also

IAsyncOperation