Copyright (c) 1999, Oracle and/or its affiliates.

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 conditions:

The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.

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. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

XkbGetKeyVirtualModMap __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
NAME
XkbGetKeyVirtualModMap - Obtain the virtual modifier map (the vmodmap array) for a subset of the keys in a keyboard description
SYNOPSIS

Status XkbGetKeyVirtualModMap "(\^Display *" "dpy" "\^," "unsigned int " "first" "\^," "unsigned int " "num" "\^," "XkbDescPtr " "xkb" "\^);"

ARGUMENTS

dpy connection to server

first keycode of first key to fetch

num number of keys for which virtual mod maps are desired

xkb Xkb description where results will be placed

DESCRIPTION

XkbGetKeyVirutalModmap sends a request to the server to obtain the virtual modifier mappings for num keys on the keyboard starting with key first. It waits for a reply and returns the virtual modifier mappings in the server->vmodmap array of xkb. If successful, XkbGetKeyVirtualModMap returns Success. The xkb parameter must be a pointer to a valid Xkb keyboard description. If the server map in the xkb parameter has not been allocated, XkbGetKeyVirtualModMap allocates and initializes it before obtaining the virtual modifier mappings. If the server does not have a compatible version of Xkb, or the Xkb extension has not been properly initialized, XkbGetKeyVirtualModMap returns BadMatch. If num is less than 1 or greater than XkbMaxKeyCount, XkbGetKeyVirtualModMap returns BadValue. If any allocation errors occur, XkbGetKeyVirtualModMap returns BadAlloc.

"RETURN VALUES"

15 Success The XkbGetKeyVirutalModmap function returns Success following a successful reply from the server to obtain the virtual modifier mappings for num keys on the keyboard starting with key first.

DIAGNOSTICS

15 BadAlloc Unable to allocate storage

15 BadMatch A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid

15 BadValue An argument is out of range