SHOpenPropSheet function
[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 SHOpenPropSheet(
_In_opt_ LPCTSTR pszCaption,
_In_opt_ HKEY ahkeys[],
UINT ckeys,
_In_opt_ const CLSID *pclsidDef,
_In_ IDataObject *pdtobj,
_In_opt_ IShellBrowser *psb,
_In_opt_ LPCTSTR pStartPage
);
Parameters
- pszCaption [in, optional]
-
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.
- ahkeys [in, optional]
-
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.
- pclsidDef [in, optional]
-
Type: const CLSID*
A pointer to the default CLSID. This value can be NULL.
- pdtobj [in]
-
Type: IDataObject*
A pointer to an IDataObject, an OLE object that can be used to carry out actions on the property sheet(s).
- psb [in, optional]
-
Type: IShellBrowser*
Not used.
- pStartPage [in, optional]
-
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.
Requirements
|
Minimum supported client |
Windows XP [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2003 [desktop apps only] |
|
End of client support |
Windows XP with SP2 |
|
End of server support |
Windows Server 2003 |
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names |
SHOpenPropSheetW (Unicode) and SHOpenPropSheetA (ANSI) |