SHAddFromPropSheetExtArray function (shlobj_core.h)

Article
10/13/2021

[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.]

Adds pages to a property sheet extension array created by SHCreatePropSheetExtArray.

Syntax

UINT SHAddFromPropSheetExtArray(
  [in] HPSXA                hpsxa,
  [in] LPFNADDPROPSHEETPAGE lpfnAddPage,
       LPARAM               lParam
);

Parameters

[in] hpsxa

Type: HPSXA

The array of property sheet handlers returned by SHCreatePropSheetExtArray.

[in] lpfnAddPage

Type: LPFNADDPROPSHEETPAGE

A pointer to an AddPropSheetPageProc callback function. It is called once for each property sheet handler. The callback function then returns the information needed to add a page to the handler's property sheet.

lParam

Type: LPARAM

A pointer to application-defined data. This data is passed to the callback function specified by lpfnAddPage.

Return value

Type: UINT

Returns the number of pages actually added.

Remarks

This function should be called only once for the property sheet extension array named in hpsxa.

This function calls each extension's IShellPropSheetExt::AddPages method. See that page for further details.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [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.0 or later)