SHOpenPropSheetA function (shlobj.h)

Article
11/20/2024

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

Creates a property sheet from a list of registry keys that contain the CLSIDs of the individual sheets, then opens the property sheet.

Syntax

BOOL SHOpenPropSheetA(
  [in, optional] LPCSTR        pszCaption,
  [in, optional] HKEY []       ahkeys,
                 UINT          ckeys,
  [in, optional] const CLSID   *pclsidDefault,
  [in]           IDataObject   *pdtobj,
  [in, optional] IShellBrowser *psb,
  [in, optional] LPCSTR        pStartPage
);

Parameters

[in, optional] pszCaption

Type: LPCTSTR

A pointer to a string that contains the caption for the property sheet. This value can be NULL if no caption is needed.

[in, optional] ahkeys

Type: HKEY[]

An array of registry keys that represent the CLSIDs of the individual property sheets.

ckeys

Type: UINT

UINT value that specifies the number of property sheets in the array specified by ahkeys.

[in, optional] pclsidDefault

Type: const CLSID*

A pointer to the default CLSID. This value can be NULL.

[in] pdtobj

Type: IDataObject*

A pointer to an IDataObject, an OLE object that can be used to carry out actions on the property sheet(s).

[in, optional] psb

Type: IShellBrowser*

Not used.

[in, optional] pStartPage

Type: LPCTSTR

A pointer to a string that specifies the start page. This value can be NULL.

Return value

Type: BOOL

Returns TRUE if the property sheet was successfully created; otherwise, FALSE.

Remarks

Note

The shlobj.h header defines SHOpenPropSheet as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

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