IShellPropSheetExt::ReplacePage method (shobjidl_core.h)

Article
10/13/2021

Replaces a page in a property sheet for a Control Panel object.

Syntax

HRESULT ReplacePage(
       EXPPS                  uPageID,
  [in] LPFNSVADDPROPSHEETPAGE pfnReplaceWith,
  [in] LPARAM                 lParam
);

Parameters

uPageID

Type: UINT

Not used.

Microsoft Windows XP and earlier: A type EXPPS identifier of the page to replace. The values for this parameter for Control Panels can be found in the Cplext.h header file.

[in] pfnReplaceWith

Type: LPFNADDPROPSHEETPAGE

A pointer to a function that the property sheet handler calls to replace a page to the property sheet. The function takes a property sheet handle returned by the CreatePropertySheetPage function and the lParam parameter passed to the ReplacePage method.

[in] lParam

Type: LPARAM

The parameter to pass to the function specified by the pfnReplacePage parameter.

Return value

Type: HRESULT

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

Remarks

To replace a page, a property sheet handler fills a PROPSHEETPAGE structure, calls CreatePropertySheetPage, and then calls the function specified by pfnReplacePage.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	shobjidl_core.h (include Shobjidl.h)
DLL	Shell32.dll (version 4.0 or later)

Share via