xcb_xkb_get_compat_map_group_rtrn_iterator(3)

1xcb_xkb_get_compat_map(3)        XCB Requests        xcb_xkb_get_compat_map(3)
2
3
4

NAME

6       xcb_xkb_get_compat_map -
7

SYNOPSIS

9       #include <xcb/xkb.h>
10
11   Request function
12       xcb_xkb_get_compat_map_cookie_t
13              xcb_xkb_get_compat_map(xcb_connection_t *conn,
14              xcb_xkb_device_spec_t deviceSpec, uint8_t groups,
15              uint8_t getAllSI, uint16_t firstSI, uint16_t nSI);
16
17   Reply datastructure
18       typedef struct xcb_xkb_get_compat_map_reply_t {
19           uint8_t  response_type;
20           uint8_t  deviceID;
21           uint16_t sequence;
22           uint32_t length;
23           uint8_t  groupsRtrn;
24           uint8_t  pad0;
25           uint16_t firstSIRtrn;
26           uint16_t nSIRtrn;
27           uint16_t nTotalSI;
28           uint8_t  pad1[16];
29       } xcb_xkb_get_compat_map_reply_t;
30
31   Reply function
32       xcb_xkb_get_compat_map_reply_t
33              *xcb_xkb_get_compat_map_reply(xcb_connection_t *conn,
34              xcb_xkb_get_compat_map_cookie_t cookie,
35              xcb_generic_error_t **e);
36
37   Reply accessors
38       xcb_xkb_sym_interpret_t *xcb_xkb_get_compat_map_si_rtrn(const
39              xcb_xkb_get_compat_map_request_t *reply);
40
41       int xcb_xkb_get_compat_map_si_rtrn_length(const
42              xcb_xkb_get_compat_map_reply_t *reply);
43
44       xcb_xkb_sym_interpret_iterator_t
45              xcb_xkb_get_compat_map_si_rtrn_iterator(const
46              xcb_xkb_get_compat_map_reply_t *reply);
47
48       xcb_xkb_mod_def_t *xcb_xkb_get_compat_map_group_rtrn(const
49              xcb_xkb_get_compat_map_request_t *reply);
50
51       int xcb_xkb_get_compat_map_group_rtrn_length(const
52              xcb_xkb_get_compat_map_reply_t *reply);
53
54       xcb_xkb_mod_def_iterator_t
55              xcb_xkb_get_compat_map_group_rtrn_iterator(const
56              xcb_xkb_get_compat_map_reply_t *reply);
57

REQUEST ARGUMENTS

59       conn      The XCB connection to X11.
60
61       deviceSpec
62                 TODO: NOT YET DOCUMENTED.
63
64       groups    TODO: NOT YET DOCUMENTED.
65
66       getAllSI  TODO: NOT YET DOCUMENTED.
67
68       firstSI   TODO: NOT YET DOCUMENTED.
69
70       nSI       TODO: NOT YET DOCUMENTED.
71

REPLY FIELDS

73       response_type
74                 The type of this reply, in this case XCB_XKB_GET_COMPAT_MAP.
75                 This field is also present in the xcb_generic_reply_t and can
76                 be used to tell replies apart from each other.
77
78       sequence  The sequence number of the last request processed by the X11
79                 server.
80
81       length    The length of the reply, in words (a word is 4 bytes).
82
83       deviceID  TODO: NOT YET DOCUMENTED.
84
85       groupsRtrn
86                 TODO: NOT YET DOCUMENTED.
87
88       firstSIRtrn
89                 TODO: NOT YET DOCUMENTED.
90
91       nSIRtrn   TODO: NOT YET DOCUMENTED.
92
93       nTotalSI  TODO: NOT YET DOCUMENTED.
94

DESCRIPTION

RETURN VALUE

97       Returns an xcb_xkb_get_compat_map_cookie_t. Errors have to be handled
98       when calling the reply function xcb_xkb_get_compat_map_reply.
99
100       If you want to handle errors in the event loop instead, use
101       xcb_xkb_get_compat_map_unchecked. See xcb-requests(3) for details.
102

ERRORS

104       This request does never generate any errors.
105

AUTHOR

108       Generated from xkb.xml. Contact xcb@lists.freedesktop.org for correc‐
109       tions and improvements.
110
111
112
113X Version 11                     libxcb 1.13.1       xcb_xkb_get_compat_map(3)