XkbGetUpdatedMap - Man Page

Status XkbGetUpdatedMap (Display *display, unsigned int which, XkbDescPtr xkb);

display

connection to X server

which

mask selecting subcomponents to populate

xkb

keyboard description to be updated

The which parameter is a bitwise inclusive OR of the masks in Table 1. If the needed  components of the xkb structure are not already allocated, XkbGetUpdatedMap allocates them. XkbGetUpdatedMap fetches the requested information for the device specified in the XkbDescRec  passed in the xkb parameter.

XkbGetUpdatedMap is synchronous; it queries the server for the desired information, waits for a  reply, and then returns. If successful, XkbGetUpdatedMap returns Success. If unsuccessful, XkbGetUpdatedMap returns one of the following: BadAlloc (unable to allocate a component in the  XkbDescRec structure), BadValue (some mask bits in which are undefined), BadImplementation (a compatible version of the Xkb extension is  not available in the server or the reply from the server was invalid).

Success

The XkbGetUpdatedMap function returns Success if a reply is received to the server query for the desired information.

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.

BadAlloc

Unable to allocate storage

BadImplementation

Invalid reply from server

BadValue

An argument is out of range

XkbChangeTypesOfKey(3), XkbCopyKeyType(3), XkbCopyKeyTypes(3), XkbGetKeyActions(3), XkbGetKeyBehaviors(3), XkbGetKeyExplicitComponents(3), XkbGetKeyModifierMap(3), XkbGetKeySyms(3), XkbGetKeyTypes(3), XkbResizeKeyActions(3), XkbResizeKeySyms(3), XkbResizeKeyType(3), XkbGetVirtualModMap(3), XkbGetVirtualMods(3)

XkbGetMap(3).