1XkbGetNames(3) XKB FUNCTIONS XkbGetNames(3)
2
3
4
6 XkbGetNames - Obtain symbolic names from the server
7
9 Status XkbGetNames (Display *dpy, unsigned int which, XkbDescPtr Xkb);
10
12 - dpy connection to the X server
13
14 - which
15 mask of names or map components to be updated
16
17 - Xkb keyboard description to be updated
18
20 XkbGetNames retrieves symbolic names for the components of the keyboard
21 extension from the X server. The which parameter specifies the name
22 components to be updated in the xkb parameter, and is the bitwise in‐
23 clusive OR of the valid names mask bits defined in Table 1.
24
25
26
27 Table 1 Symbolic Names Masks
28 ─────────────────────────────────────────────────────────────────────────────────
29 Mask Bit Value Keyboard Field
30 Component
31 ─────────────────────────────────────────────────────────────────────────────────
32 XkbKeycodesNameMask (1<<0) Xkb->names keycodes
33 XkbGeometryNameMask (1<<1) Xkb->names geometry
34 XkbSymbolsNameMask (1<<2) Xkb->names symbols
35 XkbPhysSymbolsNameMask (1<<3) Xkb->names phys_symbols
36 XkbTypesNameMask (1<<4) Xkb->names type
37 XkbCompatNameMask (1<<5) Xkb->names compat
38 XkbKeyTypeNamesMask (1<<6) Xkb->map type[*].name
39 XkbKTLevelNamesMask (1<<7) Xkb->map type[*].lvl_names[*]
40 XkbIndicatorNamesMask (1<<8) Xkb->names indicators[*]
41 XkbKeyNamesMask (1<<9) Xkb->names keys[*], num_keys
42 XkbKeyAliasesMask (1<<10) Xkb->names key_aliases[*], num_key_aliases
43 XkbVirtualModNamesMask (1<<11) Xkb->names vmods[*]
44 XkbGroupNamesMask (1<<12) Xkb->names groups[*]
45 XkbRGNamesMask (1<<13) Xkb->names radio_groups[*], num_rg
46 XkbComponentNamesMask (0x3f) Xkb->names keycodes,
47 geometry,
48 symbols,
49 physical symbols,
50 types, and
51 compatibility map
52 XkbAllNamesMask (0x3fff) Xkb->names all name components
53
54 If the names field of the keyboard description xkb is NULL, XkbGetNames
55 allocates and initializes the names component of the keyboard descrip‐
56 tion before obtaining the values specified by which. If the names
57 field of xkb is not NULL, XkbGetNames obtains the values specified by
58 which and copies them into the keyboard description Xkb.
59
60 If the map component of the xkb parameter is NULL, XkbGetNames does not
61 retrieve type or shift level names, even if XkbKeyTypeNamesMask or Xk‐
62 bKTLevelNamesMask are set in which.
63
64 XkbGetNames can return Success, or BadAlloc, BadLength, BadMatch, and
65 BadImplementation errors.
66
67 To free symbolic names, use XkbFreeNames.
68
70 BadAlloc Unable to allocate storage
71
72 BadImplementation
73 Invalid reply from server
74
75 BadLength The length of a request is shorter or longer than that
76 required to minimally contain the arguments
77
78 BadMatch A compatible version of Xkb was not available in the
79 server or an argument has correct type and range, but is
80 otherwise invalid
81
83 XkbFreeNames(3)
84
85
86
87
88X Version 11 libX11 1.8.1 XkbGetNames(3)