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

NAME

6       XkbAllocServerMap  -  Allocate  and  initialize an empty server map de‐
7       scription 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  mask selecting map components to allocate
17
18       count_acts
19              value of num_acts field in map to be allocated
20

DESCRIPTION

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

DIAGNOSTICS

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

NOTES

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