XkbGetKeySyms(3) XKB FUNCTIONS XkbGetKeySyms(3)

# [NAME](#NAME)

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

# [SYNOPSIS](#SYNOPSIS)

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

# [ARGUMENTS](#ARGUMENTS)

[*dpy*](#dpy)

connection to X server

[*first*](#first)

keycode of first key to get

[*num*](#num)

number of keycodes for which syms desired

[*xkb*](#xkb)

Xkb description to be updated

# [DESCRIPTION](#DESCRIPTION)

*XkbGetKeySyms* sends a request to the server to obtain the set of keysyms bound to *num* keys starting with the key whose keycode is *first.* It waits for a reply and returns the keysyms in the *map.syms* field of *xkb.* If successful, *XkbGetKeySyms* returns Success. The *xkb* parameter must be a pointer to a valid Xkb keyboard description.

If the client *map* in the xkb parameter has not been allocated, *XkbGetKeySyms* allocates 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, *XkbGetKeySyms* returns BadAccess. If *num* is less than 1 or greater than XkbMaxKeyCount, *XkbGetKeySyms* returns BadValue. If any allocation errors occur, *XkbGetKeySyms* returns BadAlloc.

# [RETURN VALUES](#RETURN_VALUES)

[Success](#Success)

The *XkbGetKeySyms* function returns Success if it gets a reply to a request to the server to obtain the set of keysyms bound to *num* keys starting with the key whose keycode is *first.*

# [DIAGNOSTICS](#DIAGNOSTICS)

[**BadAccess**](#BadAccess)

The Xkb extension has not been properly initialized

[**BadAlloc**](#BadAlloc)

Unable to allocate storage

[**BadValue**](#BadValue)

An argument is out of range

libX11 1.8.14 X Version 11

---

Document: XkbGetKeySyms(3) from libx11 1.8.14-r2 (Chainguard OS)
Source: https://gitlab.freedesktop.org/xorg/lib/libx11.git