Share via

IAsyncOperation::GetAsyncMode method

  • Article

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

Syntax

HRESULT GetAsyncMode(
  [out] BOOL *pfIsOpAsync
);

Parameters

  • pfIsOpAsync [out]
    Type: BOOL*

    A Boolean value that is set to VARIANT_TRUE to indicate that an asynchronous operation is supported, or VARIANT_FALSE otherwise.

Return value

Type: HRESULT

Returns S_OK if successful or a COM error value otherwise.

Remarks

The purpose of this method is to give the drop target the value of the IAsyncOperation::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 IAsyncOperation::SetAsyncMode and set fDoOpAsync to VARIANT_TRUE.

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