xcb_xkb_get_names man page

xcb_xkb_get_names —

Synopsis

#include <xcb/xkb.h>

Request function

xcb_xkb_get_names_cookie_t xcb_xkb_get_names(xcb_connection_t *conn, xcb_xkb_device_spec_t deviceSpec, uint32_t which);

Reply datastructure

typedef struct xcb_xkb_get_names_reply_t {
    uint8_t       response_type;
    uint8_t       deviceID;
    uint16_t      sequence;
    uint32_t      length;
    uint32_t      which;
    xcb_keycode_t minKeyCode;
    xcb_keycode_t maxKeyCode;
    uint8_t       nTypes;
    uint8_t       groupNames;
    uint16_t      virtualMods;
    xcb_keycode_t firstKey;
    uint8_t       nKeys;
    uint32_t      indicators;
    uint8_t       nRadioGroups;
    uint8_t       nKeyAliases;
    uint16_t      nKTLevels;
    uint8_t       pad0[4];
} xcb_xkb_get_names_reply_t;

Reply function

xcb_xkb_get_names_reply_t *xcb_xkb_get_names_reply(xcb_connection_t *conn, xcb_xkb_get_names_cookie_t cookie, xcb_generic_error_t **e);

Reply accessors

xcb_xkb_get_names_value_list_t *xcb_xkb_get_names_value_list (const xcb_xkb_get_names_request_t *reply)

Request Arguments

conn
The XCB connection to X11.
deviceSpec
TODO: NOT YET DOCUMENTED.
which
TODO: NOT YET DOCUMENTED.

Reply Fields

response_type
The type of this reply, in this case XCB_XKB_GET_NAMES. 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).
deviceID
TODO: NOT YET DOCUMENTED.
which
TODO: NOT YET DOCUMENTED.
minKeyCode
TODO: NOT YET DOCUMENTED.
maxKeyCode
TODO: NOT YET DOCUMENTED.
nTypes
TODO: NOT YET DOCUMENTED.
groupNames
TODO: NOT YET DOCUMENTED.
virtualMods
TODO: NOT YET DOCUMENTED.
firstKey
TODO: NOT YET DOCUMENTED.
nKeys
TODO: NOT YET DOCUMENTED.
indicators
TODO: NOT YET DOCUMENTED.
nRadioGroups
TODO: NOT YET DOCUMENTED.
nKeyAliases
TODO: NOT YET DOCUMENTED.
nKTLevels
TODO: NOT YET DOCUMENTED.

Return Value

Returns an xcb_xkb_get_names_cookie_t. Errors have to be handled when calling the reply function xcb_xkb_get_names_reply.

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

Errors

This request does never generate any errors.

Author

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

Referenced By

xcb_xkb_get_names_reply(3), xcb_xkb_get_names_unchecked(3) and xcb_xkb_get_names_value_list(3) are aliases of xcb_xkb_get_names(3).

libxcb 1.12 X Version 11 XCB Requests