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.]
Applies to: desktop apps only
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 |
|---|---|
|
Minimum supported server | Windows Server 2003 |
|
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) |
Send comments about this topic to Microsoft
Build date: 3/7/2012
