XCheckMaskEvent

Syntax

This function is similar to .PN XMaskEvent except that it never blocks and it returns a .PN Bool indicating if the event was returned.

Bool XCheckMaskEvent(display, event_mask, event_return)
      Display *display;
      long event_mask;
      XEvent *event_return;

Arguments

display	Specifies the connection to the X server.
event_mask	Specifies the event mask.
event_return	Returns the matched event's associated structure.

Description

The XCheckMaskEvent() function searches the event queue and then any events available on the server connection for the first event that matches the specified mask. If it finds a match, XCheckMaskEvent() removes that event, copies it into the specified XEvent structure, and returns True . The other events stored in the queue are not discarded. If the event you requested is not available, XCheckMaskEvent() returns False , and the output buffer will have been flushed.

See also

XCheckTypedEvent(), XCheckTypedWindowEvent(), XCheckWindowEvent(), XIfEvent(), XMaskEvent(), XNextEvent(), XPeekEvent(), XPutBackEvent(), XSendEvent(), XWindowEvent(), "Selecting Events Using a Window or Event Mask".

---

Christophe Tronche, [email protected]