IActionProgress::Begin method

Called when an action has begun that requires its progress be displayed to the user.

Syntax


HRESULT Begin(
  [in] SPACTION action,
  [in] SPBEGINF flags
);

Parameters

action [in]

Type: SPACTION

The action being performed. See SPACTION for a list of acceptable values.

flags [in]

Type: SPBEGINF

Optional flags that request certain UI operations be enabled or disabled. See SPBEGINF for a list of acceptable values.

Return value

Type: HRESULT

Return S_OK if successful, or an error value otherwise.

Remarks

This method should be called when an action is beginning. The values of action and flags may be used to determine how to draw the UI that will be displayed to the user, or how to interpret or filter certain user actions associated with the action. When the action has completed, IActionProgress::End should be called.

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
SPACTION
SPBEGINF
IActionProgress::End

 

 

Show: