SHCreatePropSheetExtArray function (shlobj.h)

Article
10/21/2021

[SHCreatePropSheetExtArray is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

Loads all the Shell property sheet extension handlers located under a specified registry key.

Syntax

HPSXA SHCreatePropSheetExtArray(
  [in]           HKEY   hKey,
  [in, optional] PCWSTR pszSubKey,
                 UINT   max_iface
);

Parameters

[in] hKey

Type: HKEY

The registry root key that contains the subkey with the property sheet extension handlers. For instance, HKEY_LOCAL_MACHINE.

[in, optional] pszSubKey

Type: PCWSTR

A pointer to a null-terminated string specifying the name of the subkey that contains shellex\PropertySheetHandlers.

For example, if hkey specifies HKEY_LOCAL_MACHINE and pszSubkey specifies "Software\Microsoft\Windows\CurrentVersion\Controls Folder\Display", this function returns property sheet extension handlers using the following subkey:

HKEY_LOCAL_MACHINE
   SOFTWARE
      Microsoft
         Windows
            CurrentVersion
               Controls Folder
                  Display
                     shellex
                        PropertySheetHandlers

max_iface

Type: UINT

The maximum number of property sheet handlers to be returned.

Return value

Type: HPSXA

Returns a handle to an array of property sheet handlers. Pass this value to SHAddFromPropSheetExtArray. You do not access this value directly.

Remarks

When you are finished with the returned HPSXA handle, destroy it by calling SHDestroyPropSheetExtArray.

This function loads up to max_iface property sheet extensions into an array that is then passed to SHAddFromPropSheetExtArray.

Requirements

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

Share via