GetMessageW Function

Retrieves messages from the calling thread's message queue.

Syntax

Parameters

• [out] lpMsg
  LPMSG
  
  A pointer to a MSG structure that receives message information.
• [in] hWnd
  HWND
  
  A handle to the window whose messages are to be retrieved. This parameter can be NULL to retrieve messages for any window that belongs to the calling thread.
• [in] wMsgFilterMin
  UINT
  
  The minimum value in the range of messages to be retrieved. This parameter is ignored if hWnd is NULL.
• [in] wMsgFilterMax
  UINT
  
  The maximum value in the range of messages to be retrieved. This parameter is ignored if hWnd is NULL.

Return Value

If the function succeeds, the return value is non-zero. If the function retrieves a quit message (when wMsgFilterMin and wMsgFilterMax are both zero), the return value is zero. If there is an error, the return value is -1.

Remarks

The GetMessageW function retrieves a message from the message queue of the calling thread and places the message in the structure pointed to by the lpMsg parameter.

• If hWnd is NULL, GetMessageW retrieves messages for any window that belongs to the calling thread.
• If wMsgFilterMin and wMsgFilterMax are both zero, GetMessageW retrieves all messages.
• If wMsgFilterMin and wMsgFilterMax specify a range of messages, GetMessageW retrieves only messages within that range.

See Also

• MSG structure
• PeekMessageW
• TranslateMessage
• DispatchMessageW

MSG msg;
while (GetMessage(&msg, NULL, 0, 0) > 0) {
    TranslateMessage(&msg);
    DispatchMessage(&msg);
}