Edit

PSN_WIZFINISH notification code

  • Article

Notifies a page that the user has clicked the Finish button in a wizard. This notification code is sent in the form of a WM_NOTIFY message.

PSN_WIZFINISH 

    lppsn = (LPPSHNOTIFY) lParam;

Parameters

lParam

Pointer to a PSHNOTIFY structure that contains information about the notification code. This structure contains an NMHDR structure as its first member, hdr. The hwndFrom member of this NMHDR structure contains the handle to the property sheet. The lParam member of the PSHNOTIFY structure does not contain any information.

Return value

  • Returns TRUE to prevent the wizard from finishing.
  • Version 5.80. and later. Returns a window handle to prevent the wizard from finishing. The wizard will set the focus to that window. The window must be owned by the wizard page.
  • Returns FALSE to allow the wizard to finish.

Remarks

To set the return value, the dialog box procedure for the page must use the SetWindowLong function with the DWL_MSGRESULT value, and the dialog box procedure must return TRUE.

Version 5.80. If your application returns TRUE to prevent a wizard from finishing, it has no control over which window on the page receives focus. Applications that need to stop a wizard from finishing should normally do so by returning the handle of the window on the wizard page that is to receive focus.

Requirements

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