NAME
XkbAllocClientMap - Allocate and initialize an empty client map description record SYNOPSIS Status XkbAllocClientMap (XkbDescPtr xkb, unsigned int which, unsigned int typecount); ARGUMENTS
- xkb keyboard description in which to allocate client map
- which mask selecting map components to allocate
- typecount value of numtypes field in map to be allocated DESCRIPTION Calling XkbGetMap should be sufficient for most applications to get client and server maps. As a result, most applications do not need to directly allocate client and server maps. If you change the number of key types or construct map components with‐ out loading the necessary components from the X server, do not allocate any map components directly using malloc or Xmalloc. Instead, use the Xkb allocators, XkbAllocClientMap, and XkbAllocServerMap. Similarly, use the Xkb destructors, XkbFreeClientMap, and XkbFreeServerMap instead of free or Xfree. XkbAllocClientMap allocates and initializes an empty client map in the map field of the keyboard description specified by xkb. The which parameter specifies the particular components of the client map struc‐ ture to allocate and is a mask composed by a bitwise inclusive OR of one or more of the masks shown in Table 1. Table 1 XkbAllocClientMap Masks ────────────────────────────────────────────────────────────── Mask Effect ────────────────────────────────────────────────────────────── XkbKeyTypesMask The typecount field specifies the num‐ ber of entries to preallocate for the types field of the client map. If the typecount field is less than XkbNumRe‐ quiredTypes returns BadValue. XkbKeySymsMask The minkeycode and maxkeycode fields of the xkb parameter are used to allo‐ cate the syms and keysymmap fields of the client map. The fields are allocated to contain the maximum number of entries
necessary for maxkeycode - minkeycode + 1 keys. XkbModifierMapMask The minkeycode and maxkeycode fields of the xkb parameter are used to allo‐ cate the modmap field of the client map. The field is allocated to contain the maximum number of entries necessary for
maxkeycode - minkeycode + 1 keys. NOTE: The minkeycode and maxkeycode fields of the xkb parameter must be legal values if the XkbKeySymsMask or XkbModifierMapMask masks are set in the which parameter. If they are not valid, XkbAlloc‐ ClientMap returns BadValue. If the client map of the keyboard description is not NULL, and any fields are already allocated in the client map, XkbAllocClientMap does not overwrite the existing values; it simply ignores that part of the request. The only exception is the types array. If typecount is greater than the current numtypes field of the client map, XkbAlloc‐ ClientMap resizes the types array and resets the numtypes field accordingly. If XkbAllocClientMap is successful, it returns Success. Otherwise, it can return either BadMatch, BadAlloc, or BadValue 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 SEE ALSO XkbAllocClientMap(3), XkbAllocServerMap(3), XkbFreeClientMap,(3), XkbFreeServerMap(3), XkbGetMap(3) X Version 11 libX11 1.6.5 XkbAllocClientMap(3)