xcb_get_keyboard_control man page

xcb_get_keyboard_control —

Synopsis

#include <xcb/xproto.h>

Request function

xcb_get_keyboard_control_cookie_t xcb_get_keyboard_control(xcb_connection_t *conn,

Reply datastructure

typedef struct xcb_get_keyboard_control_reply_t {
    uint8_t  response_type;
    uint8_t  global_auto_repeat;
    uint16_t sequence;
    uint32_t length;
    uint32_t led_mask;
    uint8_t  key_click_percent;
    uint8_t  bell_percent;
    uint16_t bell_pitch;
    uint16_t bell_duration;
    uint8_t  pad0[2];
    uint8_t  auto_repeats[32];
} xcb_get_keyboard_control_reply_t;

Reply function

xcb_get_keyboard_control_reply_t *xcb_get_keyboard_control_reply(xcb_connection_t *conn, xcb_get_keyboard_control_cookie_t cookie, xcb_generic_error_t **e);

Request Arguments

conn
The XCB connection to X11.

Reply Fields

response_type
The type of this reply, in this case XCB_GET_KEYBOARD_CONTROL. 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).
global_auto_repeat

One of the following values:

XCB_AUTO_REPEAT_MODE_OFF
TODO: NOT YET DOCUMENTED.
XCB_AUTO_REPEAT_MODE_ON
TODO: NOT YET DOCUMENTED.
XCB_AUTO_REPEAT_MODE_DEFAULT
TODO: NOT YET DOCUMENTED.

TODO: NOT YET DOCUMENTED.

led_mask
TODO: NOT YET DOCUMENTED.
key_click_percent
TODO: NOT YET DOCUMENTED.
bell_percent
TODO: NOT YET DOCUMENTED.
bell_pitch
TODO: NOT YET DOCUMENTED.
bell_duration
TODO: NOT YET DOCUMENTED.
auto_repeats
TODO: NOT YET DOCUMENTED.

Return Value

Returns an xcb_get_keyboard_control_cookie_t. Errors have to be handled when calling the reply function xcb_get_keyboard_control_reply.

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

Errors

This request does never generate any errors.

Author

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

Referenced By

xcb_get_keyboard_control_reply(3) and xcb_get_keyboard_control_unchecked(3) are aliases of xcb_get_keyboard_control(3).

libxcb 1.12 X Version 11 XCB Requests