---
name: "XkbRefreshKeyboardMapping"
section: "3"
platform: "linux"
package: "libx11"
version: "1.8.14-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/XkbRefreshKeyboardMapping"
---

# XkbRefreshKeyboardMapping(3)

Update the keyboard description that is internal to the X library

## NAME

XkbRefreshKeyboardMapping - Update the keyboard description that is internal to the X library

## SYNOPSIS

**Status XkbRefreshKeyboardMapping** **(XkbMapNotifyEvent \****event***);**

## ARGUMENTS

- *event*

  event initiating remapping

## DESCRIPTION

*XkbRefreshKeyboardMapping* is the Xkb equivalent of the core *XRefreshKeyboardMapping* function. It requests that the X server send the current key mapping information to this client. A client usually invokes *XkbRefreshKeyboardMapping* after receiving an XkbMapNotify event. *XkbRefreshKeyboardMapping* returns Success if it succeeds and BadMatch if the event is not an Xkb event.

The XkbMapNotify event can be generated when some client calls *XkbSetMap, XkbChangeMap, XkbGetKeyboardByName,* or any of the standard X library functions that change the keyboard mapping or modifier mapping.

## RETURN VALUES

- Success

  The *XkbRefreshKeyboardMapping* function returns Success when the request that the X server send the current key mapping information to this client is successful.

## DIAGNOSTICS

- **BadMatch**

  A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid

## SEE ALSO

[**XkbChangeMap**(3)](/XkbChangeMap/3.md), [**XkbGetKeyboardByName**(3)](/XkbGetKeyboardByName/3.md), [**XkbSetMap**(3)](/XkbSetMap/3.md), [**XRefreshKeyboardMapping**(3)](/XRefreshKeyboardMapping/3.md)