XkbAllocServerMap(3) XKB FUNCTIONS XkbAllocServerMap(3)

NAME
       XkbAllocServerMap  -  Allocate  and  initialize  an  empty  server  map
       description record

SYNOPSIS
       Status XkbAllocServerMap (XkbDescPtr xkb, unsigned int which,  unsigned
              int countacts);

ARGUMENTS
       - xkb  keyboard description in which to allocate server map

       - which
              mask selecting map components to allocate

       - countacts
              value of numacts field in map to be allocated

DESCRIPTION
       XkbAllocServerMap  allocates and initializes an empty server map in the
       server field of the keyboard description specified by xkb.   The  which
       parameter  specifies the particular components of the server map struc‐
       ture to allocate, as specified in Table 1.


                         Table 1 XkbAllocServerMap Masks
       ─────────────────────────────────────────────────────────────────────
       Mask                        Effect
       ─────────────────────────────────────────────────────────────────────
       XkbExplicitComponentsMask   The minkeycode and maxkeycode fields
                                   of  the  xkb parameter are used to allo‐
                                   cate the explicit field  of  the  server
                                   map.

       XkbKeyActionsMask           The minkeycode and maxkeycode fields
                                   of the xkb parameter are used  to  allo‐
                                   cate  the  keyacts  field of the server
                                   map. The countacts parameter is used to
                                   allocate  the  acts  field of the server
                                   map.

       XkbKeyBehaviorsMask         The minkeycode and maxkeycode fields
                                   of  the  xkb parameter are used to allo‐
                                   cate the behaviors field of  the  server
                                   map.

       XkbVirtualModMapMask        The minkeycode and maxkeycode fields
                                   of the xkb parameter are used  to  allo‐
                                   cate  the  vmodmap  field  of the server
                                   map.


       If the server map of the keyboard  description  is  not  NULL  and  any
       fields  are already allocated in the server map, XkbAllocServerMap does
       not overwrite the existing values. The only exception is with the  acts
       array. If the countacts parameter is greater than the current numacts
       field of the server map, XkbAllocServerMap resizes the acts  array  and
       resets the numacts field accordingly.

       If  XkbAllocServerMap  is successful, it returns Success. Otherwise, it
       can return either BadMatch or BadAlloc errors.

DIAGNOSTICS
       BadAlloc       Unable to allocate storage

       BadMatch       A compatible version of Xkb was  not  available  in  the
                      server or an argument has correct type and range, but is
                      otherwise invalid

       BadValue       An argument is out of range

NOTES
       The minkeycode and maxkeycode fields of the xkb parameter  must  be
       legal  values.  If  they  are not valid, XkbAllocServerMap returns Bad‐
       Value.



X Version 11                     libX11 1.6.5             XkbAllocServerMap(3)