XkbGetKeySyms.man revision 1ab64890
Copyright (c) 1999 - Sun Microsystems, Inc.
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, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, provided that the above
copyright notice(s) and this permission notice appear in all copies of
the Software and that both the above copyright notice(s) and this
permission notice appear in supporting documentation.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Except as contained in this notice, the name of a copyright holder
shall not be used in advertising or otherwise to promote the sale, use
or other dealings in this Software without prior written authorization
of the copyright holder.

XkbGetKeySyms __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
NAME
XkbGetKeySyms - Obtain the symbols for a subset of the keys in a keyboard description
SYNOPSIS
Status XkbGetKeySyms ( dpy, first, num, xkb )

Display * dpy\^;

unsigned int first\^;

unsigned int num\^;

XkbDescPtr xkb\^;

ARGUMENTS

- dpy connection to X server

- first keycode of first key to get

- num number of keycodes for which syms desired

- xkb Xkb description to be updated

DESCRIPTION

XkbGetKeySyms sends a request to the server to obtain the set of keysyms bound to num keys starting with the key whose keycode is first. It waits for a reply and returns the keysyms in the map.syms field of xkb. If successful, XkbGetKeySyms returns Success. The xkb parameter must be a pointer to a valid Xkb keyboard description. If the client map in the xkb parameter has not been allocated, XkbGetKeySyms allocates and initializes it before obtaining the symbols. If a compatible version of Xkb is not available in the server or the Xkb extension has not been properly initialized, XkbGetKeySyms returns BadAccess. If num is less than 1 or greater than XkbMaxKeyCount, XkbGetKeySyms returns BadValue. If any allocation errors occur, XkbGetKeySyms returns BadAlloc.

"RETURN VALUES"

15 Success The XkbGetKeySyms function returns Success if it gets a reply to a request to the server to obtain the set of keysyms bound to num keys starting with the key whose keycode is first.

DIAGNOSTICS

15 BadAccess The Xkb extension has not been properly initialized

15 BadAlloc Unable to allocate storage

15 BadValue An argument is out of range