XkbFreeClientMap − Free memory used by the client map member of an XkbDescRec structure


void XkbFreeClientMap

(XkbDescPtr xkb, unsigned int which, Bool



− xkb

keyboard description containing client map to free

− which

mask identifying components of map to free

− free_all

True => free all client components and map itself


XkbFreeClientMap frees the components of client map specified by which in the XkbDescRec structure specified by the xkb parameter and sets the corresponding structure component values to NULL. The which parameter specifies a combination of the client map masks shown in Table 1.

If free_all is True, which is ignored; XkbFreeClientMap frees every non-NULL structure component in the client map, frees the XkbClientMapRec structure referenced by the map member of the xkb parameter, and sets the map member to NULL.

NOTE: The min_key_code and max_key_code fields of the xkb parameter must be legal values if the XkbKeySymsMask or XkbModifierMapMask masks are set in the which parameter. If they are not valid, XkbAllocClientMap returns BadValue.


The complete description of an Xkb keyboard is given by an XkbDescRec. The component structures in the XkbDescRec represent the major Xkb components.

typedef struct {
struct _XDisplay * display; /∗ connection to X server */
unsigned short flags; /∗ private to Xkb, do not modify */
unsigned short device_spec; /∗ device of interest */
KeyCode min_key_code; /∗ minimum keycode for device */
KeyCode max_key_code; /∗ maximum keycode for device */
XkbControlsPtr ctrls; /∗ controls */
XkbServerMapPtr server; /∗ server keymap */
XkbClientMapPtr map; /∗ client keymap */
XkbIndicatorPtr indicators; /∗ indicator map */
XkbNamesPtr names; /∗ names for all components */
XkbCompatMapPtr compat; /∗ compatibility map */
XkbGeometryPtr geom; /∗ physical geometry of keyboard */
} XkbDescRec, *XkbDescPtr;

The display field points to an X display structure. The flags field is private to the library: modifying flags may yield unpredictable results. The device_spec field specifies the device identifier of the keyboard input device, or XkbUseCoreKeyboard, which specifies the core keyboard device. The min_key_code and max_key_code fields specify the least and greatest keycode that can be returned by the keyboard.

Each structure component has a corresponding mask bit that is used in function calls to indicate that the structure should be manipulated in some manner, such as allocating it or freeing it. These masks and their relationships to the fields in the XkbDescRec are shown in Table 2.

The map field of the complete Xkb keyboard description is a pointer to the Xkb client map, which is of type XkbClientMapRec:

typedef struct { /∗ Client Map */
unsigned char size_types; /∗ # occupied entries in types */
unsigned char num_types; /∗ # entries in types */
XkbKeyTypePtr types; /∗ vector of key types used by this keymap */
unsigned short size_syms; /∗ length of the syms array */
unsigned short num_syms; /∗ # entries in syms */
KeySym * syms; /∗ linear 2d tables of keysyms, 1 per key */
XkbSymMapPtr key_sym_map; /∗ 1 per keycode, maps keycode to syms */
unsigned char * modmap; /∗ 1 per keycode, real mods bound to key */
} XkbClientMapRec, *XkbClientMapPtr;



An argument is out of range



More Linux Commands

glutInitDisplayString(3) - sets the initial display mode via
The initial display mode description string is used when creating top-level windows, subwindows, and overlays to determine the OpenGL display mode for the to-be

XkbGetKeyExplicitComponents(3) - Obtain the explicit compone
Whenever a client remaps the keyboard using core protocol requests, Xkb examines the map to determine likely default values for the components that cannot be sp

XAllocSizeHints(3) - allocate size hints structure and set o
XAllocSizeHints.3 - The XAllocSizeHints function allocates and returns a pointer to a XSizeHints structure. Note that all fields in the XSizeHints structure are

Tcl_DeleteChannelHandler(3) - call a procedure when a channe
Tcl_CreateChannelHandler arranges for proc to be called in the future whenever input or output becomes possible on the channel identified by channel, or wheneve

perl589delta(1) - what is new for perl v5.8.9 (Man Page)....
This document describes differences between the 5.8.8 release and the 5.8.9 release. Notice The 5.8.9 release will be the last significant release of the 5.8.x

xdrmem_create(3) - library routines for external data repres
These routines allow C programmers to describe arbitrary data structures in a machine-independent fashion. Data for remote procedure calls are transmitted using

iswxdigit(3) - test for hexadecimal digit wide character....
The iswxdigit() function is the wide-character equivalent of the isxdigit(3) function. It tests whether wc is a wide character belonging to the wide-character c

git-config(1) - Get and set repository or global options....
You can query/set/replace/unset options with this command. The name is actually the section and the key separated by a dot, and the value will be escaped. Multi

while(n) - Execute script repeatedly as long as a condition
The while command evaluates test as an expression (in the same way that expr evaluates its argument). The value of the expression must a proper boolean value; i

ln(1) - make links between files (Commands - Linux man page)
In the 1st form, create a link to TARGET with the name LINK_NAME. In the 2nd form, create a link to TARGET in the current directory. In the 3rd and 4th forms, c

Mail::SpamAssassin::Plugin::Razor2(3pm) - perform Razor chec
Vipuls Razor is a distributed, collaborative, spam detection and filtering network based on user submissions of spam. Detection is done with signatures that eff

Locale::gettext(3pm) - message handling functions (ManPage)
The gettext module permits access from perl to the gettext() family of functions for retrieving message strings from databases constructed to internationalize s

We can't live, work or learn in freedom unless the software we use is free.