PropSheet_IsDialogMessage macro (prsht.h)

Passes a message to a property sheet dialog box and indicates whether the dialog box processed the message. You can use this macro or send the PSM_ISDIALOGMESSAGE message explicitly.

Syntax

BOOL PropSheet_IsDialogMessage(
   HWND  hDlg,
   LPMSG pMsg
);

Parameters

hDlg

Type: HWND

Handle to the property sheet.

pMsg

Type: LPMSG

Pointer to an MSG structure that contains the message to be checked.

Return value

Type: BOOL

Returns TRUE if the macro has been processed, or FALSE if the macro has not been processed.

Remarks

Your message loop should use the PropSheet_IsDialogMessage macro with modeless property sheets to pass messages to the property sheet dialog box. On systems that support Unicode, use the Unicode versions of the GetMessage and PeekMessage functions (GetMessageW and PeekMessageW) to retrieve messages.

If the return value indicates that the message was processed, it must not be passed to the TranslateMessage or DispatchMessage function.

Note  This macro is not supported when using the Aero wizard style (PSH_AEROWIZARD).
 

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

See also

PropertySheet