XkbAllocNames(3) XKB FUNCTIONS XkbAllocNames(3)

# [NAME](#NAME)

XkbAllocNames - Allocate symbolic names structures

# [SYNOPSIS](#SYNOPSIS)

**Status XkbAllocNames** **(XkbDescPtr xkb,** **unsigned int which,** **int num\_rg,** **int num\_key\_aliases);**

# [ARGUMENTS](#ARGUMENTS)

[*xkb*](#xkb)

keyboard description for which names are to be allocated

[*which*](#which)

mask of names to be allocated

[*num\_rg*](#num_rg)

total number of radio group names needed

[*num\_key\_aliases*](#num_key_aliases)

total number of key aliases needed

# [DESCRIPTION](#DESCRIPTION)

Most applications do not need to directly allocate symbolic names structures. Do not allocate a names structure directly using *malloc* or *Xmalloc* if your application changes the number of key aliases or radio groups or constructs a symbolic names structure without loading the necessary components from the X server. Instead use *XkbAllocNames.*

*XkbAllocNames* can return BadAlloc, BadMatch, and BadValue errors. The *which* parameter is the bitwise inclusive OR of the valid names mask bits defined 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

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

# [DIAGNOSTICS](#DIAGNOSTICS)

[**BadAlloc**](#BadAlloc)

Unable to allocate storage

[**BadMatch**](#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**](#BadValue)

An argument is out of range

# [SEE ALSO](#SEE_ALSO)

[**XkbFreeNames**(3)](/man/os/libx11/XkbFreeNames.3)

libX11 1.8.14 X Version 11

---

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