1. NAME

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

2. SYNOPSIS

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

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

4. DESCRIPTION

XkbGetKeyVirutalModmapsends a request to the server to obtain the virtual modifier mappings for numkeys on the keyboard starting with key first.It waits for a reply and returns the virtual modifier mappings in the server->vmodmaparray of xkb.If successful, XkbGetKeyVirtualModMapreturns Success. The xkbparameter must be a pointer to a valid Xkb keyboard description. If the servermap in the xkbparameter has not been allocated, XkbGetKeyVirtualModMapallocates 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, XkbGetKeyVirtualModMapreturns BadMatch. If numis less than 1 or greater than XkbMaxKeyCount, XkbGetKeyVirtualModMapreturns BadValue. If any allocation errors occur, XkbGetKeyVirtualModMapreturns BadAlloc.

5. RETURN VALUES

  • Success
                   The XkbGetKeyVirutalModmapfunction returns Success following a successful reply from the server to obtain the virtual modifier mappings for numkeys on the keyboard starting with key first.

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