1. NAME▲

XkbAllocServerMap - Allocate and initialize an empty server map description record

2. SYNOPSIS ▲

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

3. ARGUMENTS ▲

  • - xkb
        keyboard description in which to allocate server map
  • - which
        mask selecting map components to allocate
  • - count_acts
        value of num_acts field in map to be allocated

4. DESCRIPTION ▲

XkbAllocServerMapallocates and initializes an empty server map in the serverfield of the keyboard description specified by xkb.The whichparameter specifies the particular components of the server map structure to allocate, as specified in Table 1.

c s
l l
l lw(4i).
Table 1 XkbAllocServerMap Masks
_
Mask Effect
_
XkbExplicitComponentsMask T{
The min_key_code and max_key_code fields of the xkb parameter are used to
allocate the explicit field of the server map.
T}
.br.br
XkbKeyActionsMask T{
The min_key_code and max_key_code fields of the xkb parameter are used to allocate the key_acts field of the server map. The count_acts parameter is used to allocate the acts field of the server map.
T}
.br.br
XkbKeyBehaviorsMask T{
The min_key_code and max_key_code fields of the xkb parameter are used to allocate the behaviors field of the server map.
T}
.br.br
XkbVirtualModMapMask T{
The min_key_code and max_key_code fields of the xkb parameter are used to allocate the vmodmap field of the server map.
T}

If the server map of the keyboard description is not NULL and any fields are already allocated in the server map, XkbAllocServerMapdoes not overwrite the existing values. The only exception is with the actsarray. If the count_actsparameter is greater than the current num_actsfield of the server map, XkbAllocServerMapresizes the actsarray and resets the num_actsfield accordingly. If XkbAllocServerMapis successful, it returns Success. Otherwise, it can return either BadMatch or BadAlloc errors.

5. 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

6. NOTES ▲

The min_key_codeand max_key_codefields of the xkbparameter must be legal values. If they are not valid, XkbAllocServerMapreturns BadValue.