IDataObjectAsyncCapability::SetAsyncMode method

Called by a drop source to specify whether the data object supports asynchronous data extraction.

Syntax


HRESULT SetAsyncMode(
  [in]  BOOL fDoOpAsync
);

Parameters

fDoOpAsync [in]

Type: BOOL

VARIANT_TRUE if an asynchronous operation is supported; otherwise, VARIANT_FALSE. The default value is VARIANT_FALSE.

Return value

Type: HRESULT

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

Remarks

This method is called by the drop source to indicate that the data object supports asynchronous data extraction. Store the fDoOpAsync for later use by IDataObjectAsyncCapability::GetAsyncMode. The drop target determines whether asynchronous data extraction is supported by calling IDataObjectAsyncCapability::GetAsyncMode to retrieve the fDoOpAsync value.

If fDoOpAsync is set to VARIANT_TRUE, SetAsyncMode must call IDataObjectAsyncCapability::AddRef, and store the interface pointer for use by IDataObjectAsyncCapability::EndOperation.

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Shldisp.h

IDL

Shldisp.idl

DLL

Shell32.dll (version 6.0 or later)

See also

IDataObjectAsyncCapability

 

 

Community Additions

ADD
Show:
© 2014 Microsoft