Copyright \(co 2009 Red Hat, Inc.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

XGetEventData, XFreeEventData, XGenericEventCookie - retrieve and free additional event data through cookies.

Bool XGetEventData\^(\^Display *display\^, XGenericEventCookie *cookie\^);

void XFreeEventData\^(\^Display *display\^, XGenericEventCookie *cookie\^);

Specifies the connection to the X server. Specifies the cookie to free or retrieve the data for. .EX typedef struct { int type; unsigned long serial; Bool send_event; Display *display; int extension; int evtype; unsigned int cookie; void *data; } XGenericEventCookie; Some extension XGenericEvents require additional memory to store information. For these events, the library returns a XGenericEventCookie with a token ('cookie') unique to this event. The XGenericEventCookie 's data pointer is undefined until XGetEventData is called. The XGetEventData function retrieves this extra data for the given cookie. No round-trip to the server is required. If the cookie is invalid or the event is not an event handled by cookie handlers, False is returned. If XGetEventData returns True , the cookie's data pointer points to the memory containing the event information. A client must call XFreeEventData to free this memory. XGetEventData returns False for multiple calls for the same event cookie. The XFreeEventData function frees the data associated with a cookie. A client must call XFreeEventData for each cookie claimed with XGetEventData . .EX XEvent event; XGenericEventCookie *cookie = &ev; XNextEvent(display, &event); if (XGetEventData(display, cookie)) { handle_cookie_event(cookie->data); } else handle_event(&event); } XFreeEventData(display, cookie); A cookie is defined as unclaimed if it has been returned to the client through XNextEvent but its data has not been retrieved via XGetEventData . Subsequent calls to XNextEvent may free memory associated with unclaimed cookies. Multi-threaded X clients must ensure that XGetEventData is called before the next call to XNextEvent . XNextEvent(__libmansuffix__),

\*(xL