1. NAME

XkbGetKeySyms - Obtain the symbols for a subset of the keys in a keyboard description

2. SYNOPSIS

Status XkbGetKeySyms (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 keycodes for which syms desired
  • - xkb
        Xkb description to be updated

4. DESCRIPTION

XkbGetKeySymssends a request to the server to obtain the set of keysyms bound to numkeys starting with the key whose keycode is first.It waits for a reply and returns the keysyms in the map.symsfield of xkb.If successful, XkbGetKeySymsreturns Success. The xkbparameter must be a pointer to a valid Xkb keyboard description. If the client mapin the xkb parameter has not been allocated, XkbGetKeySymsallocates and initializes it before obtaining the symbols. If a compatible version of Xkb is not available in the server or the Xkb extension has not been properly initialized, XkbGetKeySymsreturns BadAccess. If numis less than 1 or greater than XkbMaxKeyCount, XkbGetKeySymsreturns BadValue. If any allocation errors occur, XkbGetKeySymsreturns BadAlloc.

5. RETURN VALUES

  • Success
                   The XkbGetKeySymsfunction returns Success if it gets a reply to a request to the server to obtain the set of keysyms bound to numkeys starting with the key whose keycode is first.

6. DIAGNOSTICS

BadAccess

               The Xkb extension has not been properly initialized

BadAlloc

               Unable to allocate storage

BadValue

               An argument is out of range