XkbGetKeyTypes (3)
Leading comments
Copyright 1999 Oracle and/or its affiliates. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following condition...
NAME
XkbGetKeyTypes - Obtain the list of available key types in the server's keyboard mappingSYNOPSIS
-
Status XkbGetKeyTypes
(Display *dpy,
unsigned int first,
unsigned int num,
XkbDescPtr xkb);
ARGUMENTS
- - dpy
-
- connection to X server
- - first
- index to first type to get, 0 => 1st type
- - num
- number of key types to be returned
- - xkb
- keyboard description containing client map to update
DESCRIPTION
XkbGetKeyTypes
queries the server for the desired types, waits for a reply, and returns the
desired types in the
xkb->map->types.
If successful, it returns Success.
XkbGetKeyTypes
returns BadAccess if the Xkb extension has not been properly initialized and
BadValue if the combination of
first
and
num
results in numbers out of valid range.
NOTE:
XkbGetKeyTypes
is used to obtain descriptions of the key types themselves, not the key types
bound to individual keys. To obtain the key types bound to an individual key,
refer to the
key_sym_map
field of the client map.
DIAGNOSTICS
- BadAccess
- The Xkb extension has not been properly initialized
- BadValue
- An argument is out of range