Edit

IProgressDialog::Timer method (shlobj_core.h)

  • Article

Resets the progress dialog box timer to zero.

Syntax

HRESULT Timer(
  [in] DWORD   dwTimerAction,
       LPCVOID pvResevered
);

Parameters

[in] dwTimerAction

Type: DWORD

Flags that indicate the action to be taken by the timer. One of the following values:

PDTIMER_RESET

Resets the timer to zero. Progress will be calculated from the time this method is called.

PDTIMER_PAUSE

Progress has been suspended.

PDTIMER_RESUME

Progress has been resumed.

pvResevered

Type: LPCVOID

Reserved. Set to NULL.

Return value

Type: HRESULT

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

Remarks

The timer is used to estimate the remaining time. It is started when your application calls IProgressDialog::StartProgressDialog. Unless your application will start immediately, it should call Timer just before starting the operation. This practice ensures that the time estimates will be as accurate as possible. This method should not be called after the first call to IProgressDialog::SetProgress.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header shlobj_core.h
DLL Shell32.dll (version 5.0 or later)

See also

IProgressDialog