xcb_input_xi_grab_device man page

xcb_input_xi_grab_device —

Synopsis

#include <xcb/xinput.h>

Request function

xcb_input_xi_grab_device_cookie_t xcb_input_xi_grab_device(xcb_connection_t *conn, xcb_window_t window, xcb_timestamp_t time, xcb_cursor_t cursor, xcb_input_device_id_t deviceid, uint8_t mode, uint8_t paired_device_mode, uint8_t owner_events, uint16_t mask_len, const uint32_t *mask);

Reply datastructure

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

Reply function

xcb_input_xi_grab_device_reply_t *xcb_input_xi_grab_device_reply(xcb_connection_t *conn, xcb_input_xi_grab_device_cookie_t cookie, xcb_generic_error_t **e);

Request Arguments

conn
The XCB connection to X11.
window
TODO: NOT YET DOCUMENTED.
time
TODO: NOT YET DOCUMENTED.
cursor
TODO: NOT YET DOCUMENTED.
deviceid
TODO: NOT YET DOCUMENTED.
mode
TODO: NOT YET DOCUMENTED.
paired_device_mode
TODO: NOT YET DOCUMENTED.
owner_events
TODO: NOT YET DOCUMENTED.
mask_len
TODO: NOT YET DOCUMENTED.
mask
TODO: NOT YET DOCUMENTED.

Reply Fields

response_type
The type of this reply, in this case XCB_INPUT_XI_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).
status
TODO: NOT YET DOCUMENTED.

Return Value

Returns an xcb_input_xi_grab_device_cookie_t. Errors have to be handled when calling the reply function xcb_input_xi_grab_device_reply.

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

Errors

This request does never generate any errors.

Author

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

Referenced By

xcb_input_xi_grab_device_reply(3) and xcb_input_xi_grab_device_unchecked(3) are aliases of xcb_input_xi_grab_device(3).

libxcb 1.12 X Version 11 XCB Requests