1XkbGetNames(3)                   XKB FUNCTIONS                  XkbGetNames(3)
2
3
4

NAME

6       XkbGetNames - Obtain symbolic names from the server
7

SYNOPSIS

9       Status XkbGetNames (Display *dpy, unsigned int which, XkbDescPtr xkb);
10

ARGUMENTS

12       dpy    connection to the X server
13
14       which  mask of names or map components to be updated
15
16       xkb    keyboard description to be updated
17

DESCRIPTION

19       XkbGetNames retrieves symbolic names for the components of the keyboard
20       extension from the X server. The which  parameter  specifies  the  name
21       components  to  be updated in the xkb parameter, and is the bitwise in‐
22       clusive OR of the valid names mask bits defined in Table 1.
23
24
25
26                                 Table 1 Symbolic Names Masks
27       ─────────────────────────────────────────────────────────────────────────────────
28       Mask Bit                 Value      Keyboard     Field
29                                           Component
30       ─────────────────────────────────────────────────────────────────────────────────
31       XkbKeycodesNameMask      (1<<0)     Xkb->names   keycodes
32       XkbGeometryNameMask      (1<<1)     Xkb->names   geometry
33       XkbSymbolsNameMask       (1<<2)     Xkb->names   symbols
34       XkbPhysSymbolsNameMask   (1<<3)     Xkb->names   phys_symbols
35       XkbTypesNameMask         (1<<4)     Xkb->names   type
36       XkbCompatNameMask        (1<<5)     Xkb->names   compat
37       XkbKeyTypeNamesMask      (1<<6)     Xkb->map     type[*].name
38       XkbKTLevelNamesMask      (1<<7)     Xkb->map     type[*].lvl_names[*]
39       XkbIndicatorNamesMask    (1<<8)     Xkb->names   indicators[*]
40       XkbKeyNamesMask          (1<<9)     Xkb->names   keys[*], num_keys
41       XkbKeyAliasesMask        (1<<10)    Xkb->names   key_aliases[*], num_key_aliases
42       XkbVirtualModNamesMask   (1<<11)    Xkb->names   vmods[*]
43       XkbGroupNamesMask        (1<<12)    Xkb->names   groups[*]
44       XkbRGNamesMask           (1<<13)    Xkb->names   radio_groups[*], num_rg
45       XkbComponentNamesMask    (0x3f)     Xkb->names   keycodes,
46                                                        geometry,
47                                                        symbols,
48                                                        physical symbols,
49                                                        types, and
50                                                        compatibility map
51       XkbAllNamesMask          (0x3fff)   Xkb->names   all name components
52
53       If the names field of the keyboard description xkb is NULL, XkbGetNames
54       allocates  and initializes the names component of the keyboard descrip‐
55       tion before obtaining the values specified  by  which.   If  the  names
56       field  of  xkb is not NULL, XkbGetNames obtains the values specified by
57       which and copies them into the keyboard description Xkb.
58
59       If the map component of the xkb parameter is NULL, XkbGetNames does not
60       retrieve  type or shift level names, even if XkbKeyTypeNamesMask or Xk‐
61       bKTLevelNamesMask are set in which.
62
63       XkbGetNames can return Success, or BadAlloc, BadLength,  BadMatch,  and
64       BadImplementation errors.
65
66       To free symbolic names, use XkbFreeNames.
67

DIAGNOSTICS

69       BadAlloc       Unable to allocate storage
70
71       BadImplementation
72                      Invalid reply from server
73
74       BadLength      The  length  of a request is shorter or longer than that
75                      required to minimally contain the arguments
76
77       BadMatch       A compatible version of Xkb was  not  available  in  the
78                      server or an argument has correct type and range, but is
79                      otherwise invalid
80

SEE ALSO

82       XkbFreeNames(3)
83
84
85
86
87X Version 11                     libX11 1.8.7                   XkbGetNames(3)
Impressum