xcb_input_grab_device man page

xcb_input_grab_device —

Synopsis

#include <xcb/xinput.h>

Request function

xcb_input_grab_device_cookie_t xcb_input_grab_device(xcb_connection_t *conn, xcb_window_t grab_window, xcb_timestamp_t time, uint16_t num_classes, uint8_t this_device_mode, uint8_t other_device_mode, uint8_t owner_events, uint8_t device_id, const xcb_input_event_class_t *classes);

Reply datastructure

typedef struct xcb_input_grab_device_reply_t {
    uint8_t  response_type;
    uint8_t  xi_reply_type;
    uint16_t sequence;
    uint32_t length;
    uint8_t  status;
    uint8_t  pad0[23];
} xcb_input_grab_device_reply_t;

Reply function

xcb_input_grab_device_reply_t *xcb_input_grab_device_reply(xcb_connection_t *conn, xcb_input_grab_device_cookie_t cookie, xcb_generic_error_t **e);

Request Arguments

conn

The XCB connection to X11.

grab_window

TODO: NOT YET DOCUMENTED.

time

TODO: NOT YET DOCUMENTED.

num_classes

TODO: NOT YET DOCUMENTED.

this_device_mode

TODO: NOT YET DOCUMENTED.

other_device_mode

TODO: NOT YET DOCUMENTED.

owner_events

TODO: NOT YET DOCUMENTED.

device_id

TODO: NOT YET DOCUMENTED.

classes

TODO: NOT YET DOCUMENTED.

Reply Fields

response_type

The type of this reply, in this case XCB_INPUT_GRAB_DEVICE. This field is also present in the xcb_generic_reply_t and can be used to tell replies apart from each other.

sequence

The sequence number of the last request processed by the X11 server.

length

The length of the reply, in words (a word is 4 bytes).

xi_reply_type

TODO: NOT YET DOCUMENTED.

status

TODO: NOT YET DOCUMENTED.

Description

Return Value

Returns an xcb_input_grab_device_cookie_t. Errors have to be handled when calling the reply function xcb_input_grab_device_reply.

If you want to handle errors in the event loop instead, use xcb_input_grab_device_unchecked. See xcb-requests(3) for details.

Errors

This request does never generate any errors.

See Also

Author

Generated from xinput.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.

Referenced By

The man pages xcb_input_grab_device_reply(3) and xcb_input_grab_device_unchecked(3) are aliases of xcb_input_grab_device(3).

libxcb 1.12 X Version 11 XCB Requests