IActionProgress::QueryCancel method

Provides information about whether the action is being canceled.

Syntax


HRESULT QueryCancel(
  [out] BOOL *pfCancelled
);

Parameters

pfCancelled [out]

Type: BOOL*

A reference to a BOOL value that specifies whether the action is being canceled.

Return value

Type: HRESULT

Return S_OK if successful, or an error value otherwise.

Remarks

Call this method when a process must know whether an action has been canceled. Implementing this method requires the implementing class to query either an internal or external flag to provide this information, and store the result in the value of pfCancelled.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Shobjidl.h

IDL

Shobjidl.idl

DLL

Shobjidl.idl

See also

IActionProgress
IActionProgress::ResetCancel

 

 

Show: