Edit

Share via

SHReplaceFromPropSheetExtArray function (shlobj_core.h)

  • Article

[This function is available through Windows XP Service Pack 2 (SP2) and Windows Server 2003. It might be altered or unavailable in subsequent versions of Windows.]

Requests each property sheet in a property sheet extension array to replace pages. Each page is allowed up to one replacement.

Syntax

UINT SHReplaceFromPropSheetExtArray(
  [in] HPSXA                hpsxa,
       UINT                 uPageID,
  [in] LPFNADDPROPSHEETPAGE lpfnReplaceWith,
       LPARAM               lParam
);

Parameters

[in] hpsxa

Type: HPSXA

A property sheet array handle (HPSXA) returned from a call to SHCreatePropSheetExtArray.

uPageID

Type: UINT

The ID of the page to replace.

[in] lpfnReplaceWith

Type: LPFNADDPROPSHEETPAGE

A pointer to an AddPropSheetPageProc function used by the property sheet extension to add a page to a property sheet.

lParam

Type: LPARAM

An application-defined value.

Return value

Type: UINT

The number of replacements actually performed.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header shlobj_core.h (include Shlobj.h)
Library Shell32.lib
DLL Shell32.dll (version 5.00 or later)