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

NAME

6       XkbAllocServerMap  -  Allocate  and  initialize  an  empty  server  map
7       description record
8

SYNOPSIS

10       Status XkbAllocServerMap (XkbDescPtr xkb, unsigned int which,  unsigned
11              int count_acts);
12

ARGUMENTS

14       - xkb  keyboard description in which to allocate server map
15
16       - which
17              mask selecting map components to allocate
18
19       - count_acts
20              value of num_acts field in map to be allocated
21

DESCRIPTION

23       XkbAllocServerMap  allocates and initializes an empty server map in the
24       server field of the keyboard description specified by xkb.   The  which
25       parameter  specifies the particular components of the server map struc‐
26       ture to allocate, as specified in Table 1.
27
28
29                         Table 1 XkbAllocServerMap Masks
30       ─────────────────────────────────────────────────────────────────────
31       Mask                        Effect
32       ─────────────────────────────────────────────────────────────────────
33       XkbExplicitComponentsMask   The min_key_code and max_key_code fields
34                                   of  the  xkb parameter are used to allo‐
35                                   cate the explicit field  of  the  server
36                                   map.
37
38       XkbKeyActionsMask           The min_key_code and max_key_code fields
39                                   of the xkb parameter are used  to  allo‐
40                                   cate  the  key_acts  field of the server
41                                   map. The count_acts parameter is used to
42                                   allocate  the  acts  field of the server
43                                   map.
44
45       XkbKeyBehaviorsMask         The min_key_code and max_key_code fields
46                                   of  the  xkb parameter are used to allo‐
47                                   cate the behaviors field of  the  server
48                                   map.
49
50       XkbVirtualModMapMask        The min_key_code and max_key_code fields
51                                   of the xkb parameter are used  to  allo‐
52                                   cate  the  vmodmap  field  of the server
53                                   map.
54
55
56       If the server map of the keyboard  description  is  not  NULL  and  any
57       fields  are already allocated in the server map, XkbAllocServerMap does
58       not overwrite the existing values. The only exception is with the  acts
59       array. If the count_acts parameter is greater than the current num_acts
60       field of the server map, XkbAllocServerMap resizes the acts  array  and
61       resets the num_acts field accordingly.
62
63       If  XkbAllocServerMap  is successful, it returns Success. Otherwise, it
64       can return either BadMatch or BadAlloc errors.
65

DIAGNOSTICS

67       BadAlloc       Unable to allocate storage
68
69       BadMatch       A compatible version of Xkb was  not  available  in  the
70                      server or an argument has correct type and range, but is
71                      otherwise invalid
72
73       BadValue       An argument is out of range
74

NOTES

76       The min_key_code and max_key_code fields of the xkb parameter  must  be
77       legal  values.  If  they  are not valid, XkbAllocServerMap returns Bad‐
78       Value.
79
80
81
82X Version 11                     libX11 1.6.7             XkbAllocServerMap(3)
Impressum