XGetEventData.man revision b4ee4795 
 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.

.\\$1D \\$2 \\$1
.ps \\n(PS
.if \\n(VS>=40 .vs \\n(VSu
.if \\n(VS<=39 .vs \\n(VSp
..

 0
.nr BD 0


..


.KS
.TA .5i 3i

..


.KE


..
..
.KS

.D

 choose appropriate monospace font
 the imagen conditional, 480,
 may be changed to L if LB is too
 heavy for your eyes...

..

.R
..
..
..
..
.TB


\\*(NO
.R
..
. \" Note End -- doug kraft 3/85

 0
..
.ny0

 XGetEventData __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 NAME
XGetEventData, XFreeEventData, XGenericEventCookie - retrieve and free additional event data through cookies.

 SYNTAX

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


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



 ARGUMENTS
 display 1i
Specifies the connection to the X server.

 cookie 1i
Specifies the cookie to free or retrieve the data for.


 STRUCTURES
.Ds 0
.TA .5i 3i
typedef struct {
 int type;
 unsigned long serial;
 Bool send_event;
 Display *display;
 int extension;
 int evtype;
 unsigned int cookie;
 void *data;
} XGenericEventCookie;
.De


 DESCRIPTION
Some extension
.ZN XGenericEvents
require additional memory to store information.
For these events, the library returns a
.ZN XGenericEventCookie
with a token ('cookie') unique to this event. The
.ZN XGenericEventCookie 's
data pointer is undefined until
.ZN XGetEventData
is called.

The
.ZN 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,
.ZN False
is returned. If
.ZN XGetEventData
returns
.ZN True ,
the cookie's data pointer points to the memory containing the event
information. A client must call
.ZN XFreeEventData
to free this memory.
.ZN XGetEventData
returns
.ZN False
for multiple calls for the same event cookie.

The
.ZN XFreeEventData
function frees the data associated with a cookie. A client must call
.ZN XFreeEventData
for each cookie claimed with
.ZN XGetEventData .


 EXAMPLE CODE
.Ds 0
.TA .5i 3i
XEvent event;
XGenericEventCookie *cookie = &ev;

XNextEvent(display, &event);
if (XGetEventData(display, cookie)) {
 handle_cookie_event(cookie->data);
} else
 handle_event(&event);
}
XFreeEventData(display, cookie);
.De


 NOTES
A cookie is defined as unclaimed if it has been returned to the client
through
.ZN XNextEvent
but its data has not been retrieved via
.ZN XGetEventData .
Subsequent calls to
.ZN XNextEvent
may free memory associated with unclaimed cookies.
Multi-threaded X clients must ensure that
.ZN XGetEventData
is called before the next call to
.ZN XNextEvent .


 "SEE ALSO"
XNextEvent(__libmansuffix__),


\*(xL