Manual Pages for UNIX Operating System command usage for man XkbGetKeyVirtualModMap

XKB FUNCTIONS                        XkbGetKeyVirtualModMap(3x11)



NAME
     XkbGetKeyVirtualModMap - Obtain  the  virtual  modifier  map
     (the  vmodmap  array) for a subset of the keys in a keyboard
     description

SYNOPSIS
     cc [ flag... ] file... -lX11 [ library... ]

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

ARGUMENTS
     - dpy
          connection to server

     - first
          keycode of first key to fetch

     - num
          number of keys for which virtual mod maps are desired

     - xkb
          Xkb description where results will be placed

DESCRIPTION
     XkbGetKeyVirutalModmap sends a  request  to  the  server  to
     obtain  the  virtual  modifier  mappings for num keys on the
     keyboard starting with key first. It waits for a  reply  and
     returns the virtual modifier mappings in the server->vmodmap
     array of xkb. If successful, XkbGetKeyVirtualModMap  returns
     Success.  The xkb parameter must be a pointer to a valid Xkb
     keyboard description.

     If the server map in the xkb parameter has  not  been  allo-
     cated,  XkbGetKeyVirtualModMap  allocates and initializes it
     before obtaining the virtual modifier mappings.

     If the server does not have a compatible version of Xkb,  or
     the Xkb extension has not been properly initialized, XkbGet-
     KeyVirtualModMap returns BadMatch. If num is less than 1  or
     greater  than XkbMaxKeyCount, XkbGetKeyVirtualModMap returns
     BadValue. If any allocation errors occur,  XkbGetKeyVirtual-
     ModMap returns BadAlloc.

RETURN VALUES
     Success        The XkbGetKeyVirutalModmap  function  returns
                    Success following a successful reply from the
                    server to obtain the  virtual  modifier  map-
                    pings  for  num keys on the keyboard starting
                    with key first.





X Version 11        Last change: libX11 1.3.5                   1






XKB FUNCTIONS                        XkbGetKeyVirtualModMap(3x11)



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


ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:

     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Availability                | x11/library/libx11          |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | See XInitThreads(3X11)      |
    |_____________________________|_____________________________|
































X Version 11        Last change: libX11 1.3.5                   2