IProgressDialog::SetProgress method (shlobj_core.h)

  • Article

Updates the progress dialog box with the current state of the operation.

Syntax

HRESULT SetProgress(
  [in] DWORD dwCompleted,
  [in] DWORD dwTotal
);

Parameters

[in] dwCompleted

Type: DWORD

An application-defined value that indicates what proportion of the operation has been completed at the time the method was called.

[in] dwTotal

Type: DWORD

An application-defined value that specifies what value dwCompleted will have when the operation is complete.

Return value

Type: HRESULT

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

Remarks

Use any convenient numerical measure of the progress of the operation. To use values larger than 4 gigabytes (GB), you can instead call IProgressDialog::SetProgress64.

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