Edit

Share via

IIOCancelInformation::GetCancelInformation method (shobjidl_core.h)

  • Article

Returns information that is posted when a user selects Cancel from the progress UI. The process thread uses this method to find out which message the progress dialog will send to the process thread when the user hits cancel. The process thread then listens for this message and does its own cleanup upon receipt.

Syntax

HRESULT GetCancelInformation(
  [out] DWORD *pdwThreadID,
  [out] UINT  *puMsgCancel
);

Parameters

[out] pdwThreadID

Type: DWORD*

When this method returns, contains a pointer to the ID of the process thread.

[out] puMsgCancel

Type: UINT*

When this method returns, contains a pointer to uMsgCancel that the process thread should post if the operation is canceled.

Return value

Type: HRESULT

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

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header shobjidl_core.h (include Shobjidl.h)
DLL Shell32.dll