xcb_input_get_device_key_mapping man page

xcb_input_get_device_key_mapping —

Synopsis

#include <xcb/xinput.h>

Request function

xcb_input_get_device_key_mapping_cookie_t xcb_input_get_device_key_mapping(xcb_connection_t *conn, uint8_t device_id, xcb_input_key_code_t first_keycode, uint8_t count);

Reply datastructure

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

Reply function

xcb_input_get_device_key_mapping_reply_t *xcb_input_get_device_key_mapping_reply(xcb_connection_t *conn, xcb_input_get_device_key_mapping_cookie_t cookie, xcb_generic_error_t **e);

Reply accessors

xcb_keysym_t *xcb_input_get_device_key_mapping_keysyms(const xcb_input_get_device_key_mapping_request_t *reply);

int xcb_input_get_device_key_mapping_keysyms_length(const xcb_input_get_device_key_mapping_reply_t *reply);

xcb_generic_iterator_t xcb_input_get_device_key_mapping_keysyms_end(const xcb_input_get_device_key_mapping_reply_t *reply);

Request Arguments

conn

The XCB connection to X11.

device_id

TODO: NOT YET DOCUMENTED.

first_keycode

TODO: NOT YET DOCUMENTED.

count

TODO: NOT YET DOCUMENTED.

Reply Fields

response_type

The type of this reply, in this case XCB_INPUT_GET_DEVICE_KEY_MAPPING. 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.

keysyms_per_keycode

TODO: NOT YET DOCUMENTED.

Description

Return Value

Returns an xcb_input_get_device_key_mapping_cookie_t. Errors have to be handled when calling the reply function xcb_input_get_device_key_mapping_reply.

If you want to handle errors in the event loop instead, use xcb_input_get_device_key_mapping_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_get_device_key_mapping_keysyms(3), xcb_input_get_device_key_mapping_keysyms_end(3), xcb_input_get_device_key_mapping_keysyms_length(3), xcb_input_get_device_key_mapping_reply(3) and xcb_input_get_device_key_mapping_unchecked(3) are aliases of xcb_input_get_device_key_mapping(3).

libxcb 1.12 X Version 11 XCB Requests