GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  XGENERICEVENTCOOKIE (3)

NAME

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

CONTENTS

Syntax
Arguments
Structures
Description
Example Code
Notes

SYNTAX

Bool XGetEventData(Display *display, XGenericEventCookie *cookie);
void XFreeEventData(Display *display, XGenericEventCookie *cookie);

ARGUMENTS

display Specifies the connection to the X server.
cookie Specifies the cookie to free or retrieve the data for.

STRUCTURES







typedef struct {
        int type;
        unsigned long serial;
        Bool send_event;
        Display *display;
        int extension;
        int evtype;
        unsigned int cookie;
        void *data;
} XGenericEventCookie;











DESCRIPTION

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.

EXAMPLE CODE







XEvent event;
XGenericEventCookie *cookie = &ev;

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

NOTES

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.

SEE ALSO

XNextEvent(3),
Xlib - C Language X Interface

Search for    or go to Top of page |  Section 3 |  Main Index


X Version 11 XGETEVENTDATA (3) libX11 1.6.3

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.