IDataObjectAsyncCapability::GetAsyncMode method (shldisp.h)

Called by a drop target to determine whether the data object supports asynchronous data extraction.

Syntax

HRESULT GetAsyncMode(
  [out] BOOL *pfIsOpAsync
);

Parameters

[out] pfIsOpAsync

Type: BOOL*

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

Return value

Type: HRESULT

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

Remarks

The purpose of this method is to give the drop target the value of the IDataObjectAsyncCapability::SetAsyncMode method's fDoOpAsync parameter. This parameter is set to VARIANT_FALSE by default. If the data object supports asynchronous data extraction, it must call IDataObjectAsyncCapability::SetAsyncMode and set fDoOpAsync to VARIANT_TRUE.

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