xcb_xkb_get_named_indicator

Section: XCB Requests (3)
Updated: libxcb 1.13.1
Page Index

NAME

xcb_xkb_get_named_indicator -

SYNOPSIS

#include <xcb/xkb.h>

Request function

: xcb_xkb_get_named_indicator_cookie_t xcb_xkb_get_named_indicator(xcb_connection_t *conn, xcb_xkb_device_spec_t deviceSpec, xcb_xkb_led_class_spec_t ledClass, xcb_xkb_id_spec_t ledID, xcb_atom_t indicator);

Reply datastructure


typedef struct xcb_xkb_get_named_indicator_reply_t {
    uint8_t    response_type;
    uint8_t    deviceID;
    uint16_t   sequence;
    uint32_t   length;
    xcb_atom_t indicator;
    uint8_t    found;
    uint8_t    on;
    uint8_t    realIndicator;
    uint8_t    ndx;
    uint8_t    map_flags;
    uint8_t    map_whichGroups;
    uint8_t    map_groups;
    uint8_t    map_whichMods;
    uint8_t    map_mods;
    uint8_t    map_realMods;
    uint16_t   map_vmod;
    uint32_t   map_ctrls;
    uint8_t    supported;
    uint8_t    pad0[3];
} xcb_xkb_get_named_indicator_reply_t;

Reply function

: xcb_xkb_get_named_indicator_reply_t *xcb_xkb_get_named_indicator_reply(xcb_connection_t *conn, xcb_xkb_get_named_indicator_cookie_t cookie, xcb_generic_error_t **e);

REQUEST ARGUMENTS

conn: The XCB connection to X11.
deviceSpec: TODO: NOT YET DOCUMENTED.
ledClass: TODO: NOT YET DOCUMENTED.
ledID: TODO: NOT YET DOCUMENTED.
indicator: TODO: NOT YET DOCUMENTED.

REPLY FIELDS

response_type: The type of this reply, in this case XCB_XKB_GET_NAMED_INDICATOR. 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.
indicator: TODO: NOT YET DOCUMENTED.
found: TODO: NOT YET DOCUMENTED.
on: TODO: NOT YET DOCUMENTED.
realIndicator: TODO: NOT YET DOCUMENTED.
ndx: TODO: NOT YET DOCUMENTED.
map_flags: TODO: NOT YET DOCUMENTED.
map_whichGroups: TODO: NOT YET DOCUMENTED.
map_groups: TODO: NOT YET DOCUMENTED.
map_whichMods: TODO: NOT YET DOCUMENTED.
map_mods: TODO: NOT YET DOCUMENTED.
map_realMods: TODO: NOT YET DOCUMENTED.
map_vmod: TODO: NOT YET DOCUMENTED.
map_ctrls: TODO: NOT YET DOCUMENTED.
supported: TODO: NOT YET DOCUMENTED.

DESCRIPTION

RETURN VALUE

Returns an xcb_xkb_get_named_indicator_cookie_t. Errors have to be handled when calling the reply function xcb_xkb_get_named_indicator_reply.

If you want to handle errors in the event loop instead, use xcb_xkb_get_named_indicator_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.