HelpMessageFilterHookFunction

3.1

  #include <scrnsave.h>    

  DWORD HelpMessageFilterHookFunction(nCode, wParam, lpMsg)    
  int nCode; /* identifier of hook */
  WORD wParam; /* virtual-key code, */  
  LPMSG lpMsg; /* address of message, */  

The HelpMessageFilterHookFunction function posts a message when the user presses the F1 key while using one of the screen saver dialog boxes.

Parameters

nCode

Specifies a code used by the Windows hook function (also called the message-filter function) to determine how to process the message.

wParam

Specifies the virtual-key code pressed by the user.

lpMsg

Points to a message identifying the key event.

Return Value

The return value is TRUE if the function posts a message. Otherwise, it specifies the result of the default message processing and is determined by the value of the nCode parameter.

Comments

The HelpMessageFilterHookFunction function is provided in SCRNSAVE.LIB. Most applications export the function and check for the help message registered by the library without explicitly calling the function in their code. This reference information for HelpMessageFilterHookFunction is provided for applications that change the default behavior.

The HelpMessageFilterHookFunction function posts a registered message called MyHelpMessage. An application should check for this message in its ScreenSaverConfigureDialog function.

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

See Also

ScreenSaverConfigureDialog