windows_win::raw::message

Function peek

Source 
pub fn peek(
    window: Option<HWND>,
    range_low: Option<UINT>,
    range_high: Option<UINT>,
    handle_type: Option<UINT>,
) -> Result<Option<MSG>>
Expand description

Retrieves a message from the calling thread’s message queue.

A non-blocking version of get().

If no message presents in queue then returns None.

§Parameters:

  • window - A handle to the window whose messages are to be retrieved. The window must belong to the current thread.
  • range_low - Integer value of the lowest message to retrieve.
  • range_high - Integer value of the highest message to retrieve.
  • handle_type - Determines how retrieved message is handled. See details

§Return

  • Ok - Successfully retrieved message..
  • Err - Impossible to retrieve message.