Skip to content

Latest commit

 

History

History
97 lines (71 loc) · 3.59 KB

nf-scrnsave-screensaverconfiguredialog.md

File metadata and controls

97 lines (71 loc) · 3.59 KB
Raw
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:scrnsave.ScreenSaverConfigureDialog
ScreenSaverConfigureDialog function (scrnsave.h)
Receives messages sent to a screen saver's configuration dialog box. A screen saver that allows user configuration must define this function.
ScreenSaverConfigureDialog
ScreenSaverConfigureDialog function [Windows Shell]
_win32_ScreenSaverConfigureDialog
scrnsave/ScreenSaverConfigureDialog
shell.ScreenSaverConfigureDialog
shell\ScreenSaverConfigureDialog.htm
shell
84c2966f-8f01-4f8d-9cec-c7fef657bff0
12/05/2018
ScreenSaverConfigureDialog, ScreenSaverConfigureDialog function [Windows Shell], _win32_ScreenSaverConfigureDialog, scrnsave/ScreenSaverConfigureDialog, shell.ScreenSaverConfigureDialog
scrnsave.h
Windows
Windows XP [desktop apps only]
Windows 2000 Server [desktop apps only]
Scrnsave.lib
None
Windows
19H1
ScreenSaverConfigureDialog
scrnsave/ScreenSaverConfigureDialog
c++
APIRef
kbSyntax
DllExport
None
ScreenSaverConfigureDialog

ScreenSaverConfigureDialog function

-description

Receives messages sent to a screen saver's configuration dialog box. A screen saver that allows user configuration must define this function.

-parameters

-param hDlg

Type: HWND

The identifier of the configuration dialog box.

-param message

Type: UINT

A message that was sent to the screen saver's configuration dialog box.

-param wParam

Type: WPARAM

Additional message-specific information.

-param lParam

Type: LPARAM

Additional message-specific information.

-returns

Type: BOOL

If the function successfully processes the message, it should return TRUE. If not, it should return FALSE, except in response to a WM_INITDIALOG message. In response to a WM_INITDIALOG message, ScreenSaverConfigureDialog should return FALSE if it calls the SetFocus function to set the keyboard focus to one of the controls in the dialog box. Otherwise, the function should return TRUE, in which case the system sets the keyboard focus to the first control in the dialog box that can be given the focus.

-remarks

The dialog box template for the configuration dialog box must have the DLG_SCRNSAVECONFIGURE identifier.

The dialog box procedure is used only if the application specifies the default window class (WC_DIALOG) for the dialog box. The application uses the default class if no explicit class is given in the dialog box template. Although the dialog box procedure is similar to a window procedure, it must not call the DefWindowProc function to process unwanted messages. Unwanted messages are processed internally by the default dialog box procedure.

The ScreenSaverConfigureDialog function must be exported by including it in the EXPORTS statement in the application's module-definition (.def) file.

-see-also

RegisterDialogClasses