Reference

PeekMessageW(3w)

PeekMessageW Check queue for messages

NAME

PeekMessageW - PeekMessageW Check queue for messages

SYNOPSIS

BOOL32 PeekMessageW
(

LPMSG32 lpmsg,

HWND32 hwnd,

UINT32 min,

UINT32 max,

UINT32 wRemoveMsg
);

PARAMETERS

LPMSG32 lpmsg

Buffer to receive message.

HWND32 hwnd

Restrict to messages for hwnd.

UINT32 min

Minimum message to receive.

UINT32 max

Maximum message to receive.

UINT32 wRemoveMsg

Removal flags.

DESCRIPTION

Checks for a message in the thread's queue, filtered as for GetMessage(). Returns immediately whether a message is available or not.

Whether a retrieved message is removed from the queue is set by the _wRemoveMsg_ flags, which should be one of the following values:

PM_NOREMOVE Do not remove the message from the queue.

PM_REMOVE Remove the message from the queue.

In addition, PM_NOYIELD may be combined into _wRemoveMsg_ to request that the system not yield control during PeekMessage(); however applications may not rely on scheduling behavior.

RETURNS

Nonzero if a message is available and is retrieved, zero otherwise.

CONFORMANCE

ECMA-234, Win32.

SEE ALSO

SetDoubleClickTime(3w), GetDoubleClickTime(3w), PeekMessageA(3w), GetMessageA(3w), GetMessageW(3w), PostMessageA(3w), PostMessageW(3w), PostThreadMessageA(3w), SendMessageA(3w), SendMessageW(3w), SendMessageTimeoutA(3w), SendMessageTimeoutW(3w), WaitMessage(3w), MsgWaitForMultipleObjects(3w), TranslateMessage(3w), DispatchMessageA(3w), DispatchMessageW(3w), RegisterWindowMessageA(3w), RegisterWindowMessageW(3w), GetTickCount(3w), InSendMessage(3w), BroadcastSystemMessage(3w), SendNotifyMessageA(3w), SendMessageCallbackA(3w)