PropSheet_AddPage macro (prsht.h)

Adds a new page to the end of an existing property sheet. You can use this macro or send the PSM_ADDPAGE message explicitly.

Syntax

BOOL PropSheet_AddPage(
   HWND           hDlg,
   HPROPSHEETPAGE hpage
);

Parameters

hDlg

Type: HWND

Handle to the property sheet.

hpage

Type: HPROPSHEETPAGE

Handle to the page to add. The page must have been created by a previous call to the CreatePropertySheetPage function.

Return value

Type: BOOL

Returns TRUE if successful, or FALSE otherwise.

Remarks

The new page should be no larger than the largest page currently in the property sheet because the property sheet is not resized to fit the new page.

A number of messages and one function call occur while the property sheet is manipulating the list of pages. While this action is taking place, attempting to modify the list of pages will have unpredictable results. Accordingly, you should not use the PropSheet_AddPage macro in your implementation of PropSheetPageProc or while handling the following notifications and Microsoft Windows messages:

• PSN_APPLY
• PSN_KILLACTIVE
• PSN_RESET
• PSN_SETACTIVE
• WM_DESTROY
• WM_INITDIALOG

If you need to modify a property sheet page while you are handling one of these messages or while PropSheetPageProc is in operation, post yourself a private Windows message. Your application will not receive that message until after the property sheet manager has finished its tasks. Then you can modify the list of pages.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	prsht.h