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

NAME

6       XkbGetKeyVirtualModMap  -  Obtain the virtual modifier map (the vmodmap
7       array) for a subset of the keys in a keyboard description
8

SYNOPSIS

10       Status XkbGetKeyVirtualModMap (Display *dpy, unsigned  int  first,  un‐
11              signed int num, XkbDescPtr xkb);
12

ARGUMENTS

14       dpy    connection to server
15
16       first  keycode of first key to fetch
17
18       num    number of keys for which virtual mod maps are desired
19
20       xkb    Xkb description where results will be placed
21

DESCRIPTION

23       XkbGetKeyVirutalModmap sends a request to the server to obtain the vir‐
24       tual modifier mappings for num keys on the keyboard starting  with  key
25       first.   It waits for a reply and returns the virtual modifier mappings
26       in the server->vmodmap array  of  xkb.   If  successful,  XkbGetKeyVir‐
27       tualModMap  returns  Success.  The xkb parameter must be a pointer to a
28       valid Xkb keyboard description.
29
30       If the server map in the xkb parameter  has  not  been  allocated,  Xk‐
31       bGetKeyVirtualModMap  allocates and initializes it before obtaining the
32       virtual modifier mappings.
33
34       If the server does not have a compatible version of Xkb, or the Xkb ex‐
35       tension  has  not been properly initialized, XkbGetKeyVirtualModMap re‐
36       turns BadMatch. If num is less than 1 or greater  than  XkbMaxKeyCount,
37       XkbGetKeyVirtualModMap  returns  BadValue. If any allocation errors oc‐
38       cur, XkbGetKeyVirtualModMap returns BadAlloc.
39

RETURN VALUES

41       Success        The XkbGetKeyVirutalModmap function returns Success fol‐
42                      lowing  a successful reply from the server to obtain the
43                      virtual modifier mappings for num keys on  the  keyboard
44                      starting with key first.
45

DIAGNOSTICS

47       BadAlloc       Unable to allocate storage
48
49       BadMatch       A  compatible  version  of  Xkb was not available in the
50                      server or an argument has correct type and range, but is
51                      otherwise invalid
52
53       BadValue       An argument is out of range
54
55
56
57X Version 11                     libX11 1.8.7        XkbGetKeyVirtualModMap(3)
Impressum