1. NAME

XkbGetKeyModifierMap - Update the modifier map for one or more of the keys in a keyboard description

2. SYNOPSIS

Status XkbGetKeyModifierMap (Display * dpy , unsigned int first , unsigned int num , XkbDescPtr xkb );

3. ARGUMENTS

  • - dpy
        connection to X server
  • - first
        keycode of first key to get
  • - num
        number of keys for which information is desired
  • - xkb
        keyboard description to update

4. DESCRIPTION

The modmapentry of the client map is an array, indexed by keycode, specifying the real modifiers bound to a key. Each entry is a mask composed of a bitwise inclusive OR of the legal real modifiers: ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, Mod4Mask, and Mod5Mask. If a bit is set in a modmapentry, the corresponding key is bound to that modifier. Pressing or releasing the key bound to a modifier changes the modifier set and unset state. The particular manner in which the modifier set and unset state changes is determined by the behavior and actions assigned to the key. XkbGetKeyModifierMapsends a request to the server for the modifier mappings for numkeys starting with the key whose keycode is first.It waits for a reply and places the results in the xkb->map->modmaparray. If successful, XkbGetKeyModifierreturns Success. If the map component of the xkbparameter has not been allocated, XkbGetKeyModifierMapallocates and initializes it. If a compatible version of Xkb is not available in the server or the Xkb extension has not been properly initialized, XkbGetKeySymsreturns BadAccess. If any allocation errors occur while obtaining the modifier map, XkbGetKeyModifierMapreturns BadAlloc.

5. DIAGNOSTICS

BadAccess

               The Xkb extension has not been properly initialized

BadAlloc

               Unable to allocate storage