PropSheet_CancelToClose macro (prsht.h)

Used when changes made since the most recent PSN_APPLY notification cannot be canceled. You can also send a PSM_CANCELTOCLOSE message explicitly.

Syntax

VOID PropSheet_CancelToClose(
   HWND hDlg
);

Parameters

hDlg

Type: HWND

Handle to the property sheet.

Return value

Type: VOID

No return value.

Remarks

PSM_CANCELTOCLOSE disables the Cancel button and changes the text of the OK button to "Close". You can use this macro or send the PSM_CANCELTOCLOSE message explicitly.

Most property sheets wait to perform irreversible changes until a PSN_APPLY notification is received. However, in some circumstances, a property sheet may make irreversible changes outside the standard PSN_APPLY/PSN_RESET sequence. One example is a property sheet that contains an Edit button that is used to display a subdialog box for editing a property. When the user clicks OK to submit the change, the property sheet page has several options:

• It can record the changes but wait until it receives a PSN_APPLY notification to apply them. This is the preferred approach.
• It can apply the changes immediately after exiting the subdialog box, but remember the original settings. Those settings can be used to restore the original state if a PSN_RESET notification is received.
• It can apply the changes immediately and not attempt to restore the original settings when it receives a PSN_RESET notification. This approach is not recommended, but may be necessary if the changes are too far-reaching for the other two options to be practical.

Requirements