|
Overview |
|
|
|
Group |
|
|
|
Quick Info
Windows NT
| Yes
| Win95
| Yes
| Win32s
| Yes
| Import Library
| comctl32.lib
| Header File
| prsht.h
| Unicode
| WinNT
| Platform Notes
| None
|
|
|
PropertySheet
The PropertySheet function creates a property sheet and adds the pages defined in the specified
property sheet header structure.
int PropertySheet(
LPCPROPSHEETHEADER lppsph
|
| );
|
|
Parameters
lppsph
Pointer to a PROPSHEETHEADER structure that defines the frame and pages of a property sheet.
Return Values
Returns a positive value if successful or 1 otherwise.
If the dwFlags member of the PROPSHEETHEADER structure specifies the PSH_MODELESS flag, the successful return value is the
window handle of the property sheet dialog.
The following return values have a special meaning:
Value
| Meaning
| ID_PSREBOOTSYSTEM
| A page sent the PSM_REBOOTSYSTEM message to the property sheet. The computer
must be restarted for the user's changes to take effect.
| ID_PSRESTARTWINDOWS
| A page sent the PSM_RESTARTWINDOWS message to the property sheet. Windows must
be restarted for the user's changes to take effect.
|
Remarks
By default, PropertySheet creates a modal dialog. If the dwFlags member of the PROPSHEETHEADER structure specifies the PSH_MODELESS flag, PropertySheet creates a modeless dialog and returns immediately after the dialog is
created. In this case, the PropertySheet return value is the window handle of the modeless dialog.
For a modeless property sheet, your message loop should use
PSM_ISDIALOGMESSAGE to pass messages to the property sheet dialog. Your message loop should use
PSM_GETCURRENTPAGEHWND to determine when to destroy the dialog. When the user
selects the OK or Cancel button, PSM_GETCURRENTPAGEHWND returns NULL, and you can
then use the DestroyWindow function to destroy the dialog.
See Also
DestroyWindow, PROPSHEETHEADER, PSM_GETCURRENTPAGEHWND, PSM_ISDIALOGMESSAGE, PSM_REBOOTSYSTEM, PSM_RESTARTWINDOWS
Related Links
Software for Delphi and C++ Builder developers
Software for Visual Studio .NET developers
Software for Visual Basic 6 developers
Delphi Tips&Tricks
MegaDetailed.NET
TMS Scripter Studio Pro components for Delphi/C++Builder
More Online Helps
Win32 Multimedia Programmer's Reference (mmedia.hlp)
OLE Programmer's Reference (ole.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Microsoft Windows Telephony API (TAPI) Programmer's Reference (tapi.hlp)
Unix Manual Pages
|