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,
11              unsigned int num, XkbDescPtr xkb);
12

ARGUMENTS

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

DESCRIPTION

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

RETURN VALUES

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

DIAGNOSTICS

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