XkbFreeNames(3) XKB FUNCTIONS XkbFreeNames(3)

# [NAME](#NAME)

XkbFreeNames - Free symbolic names structures

# [SYNOPSIS](#SYNOPSIS)

**void XkbFreeNames** **(XkbDescPtr xkb,** **unsigned int which,** **Bool free\_map);**

# [ARGUMENTS](#ARGUMENTS)

[*xkb*](#xkb)

keyboard description for which names are to be freed

[*which*](#which)

mask of names components to be freed

[*free\_map*](#free_map)

True => XkbNamesRec structure itself should be freed

# [DESCRIPTION](#DESCRIPTION)

Do not free symbolic names structures directly using *free* or *XFree.* Use *XkbFreeNames* instead.

The *which* parameter is the bitwise inclusive OR of the valid names mask bits defined in Table 1.

Xkb provides several functions that work with symbolic names. Each of these functions uses a mask to specify individual fields of the structures described above. These masks and their relationships to the fields in a keyboard description are shown in Table 1.

Table 1 Symbolic Names Masks Mask Bit Value Keyboard Field Component XkbKeycodesNameMask (1<<0) Xkb->names keycodes XkbGeometryNameMask (1<<1) Xkb->names geometry XkbSymbolsNameMask (1<<2) Xkb->names symbols XkbPhysSymbolsNameMask (1<<3) Xkb->names phys\_symbols XkbTypesNameMask (1<<4) Xkb->names type XkbCompatNameMask (1<<5) Xkb->names compat XkbKeyTypeNamesMask (1<<6) Xkb->map type\[\*].name XkbKTLevelNamesMask (1<<7) Xkb->map type\[\*].lvl\_names\[\*] XkbIndicatorNamesMask (1<<8) Xkb->names indicators\[\*] XkbKeyNamesMask (1<<9) Xkb->names keys\[\*], num\_keys XkbKeyAliasesMask (1<<10) Xkb->names key\_aliases\[\*], num\_key\_aliases XkbVirtualModNamesMask (1<<11) Xkb->names vmods\[\*] XkbGroupNamesMask (1<<12) Xkb->names groups\[\*] XkbRGNamesMask (1<<13) Xkb->names radio\_groups\[\*], num\_rg XkbComponentNamesMask (0x3f) Xkb->names keycodes, geometry, symbols, physical symbols, types, and compatibility map XkbAllNamesMask (0x3fff) Xkb->names all name components

libX11 1.8.14 X Version 11

---

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