XkbRefreshKeyboardMapping.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.

XkbRefreshKeyboardMapping __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
NAME
XkbRefreshKeyboardMapping - Update the keyboard description that is internal to the X library
SYNOPSIS
Status XkbRefreshKeyboardMapping ( event )

XkbMapNotifyEvent * event\^;

ARGUMENTS

- event event initiating remapping

DESCRIPTION

XkbRefreshKeyboardMapping is the Xkb equivalent of the core XRefreshKeyboardMapping function. It requests that the X server send the current key mapping information to this client. A client usually invokes XkbRefreshKeyboardMapping after receiving an XkbMapNotify event. XkbRefreshKeyboardMapping returns Success if it succeeds and BadMatch if the event is not an Xkb event. The XkbMapNotify event can be generated when some client calls XkbSetMap, XkbChangeMap, XkbGetKeyboardByName, or any of the standard X library functions that change the keyboard mapping or modifier mapping.

"RETURN VALUES"

15 Success The XkbRefreshKeyboardMapping function returns Success when the request that the X server send the current key mapping information to this client is successful.

DIAGNOSTICS

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

"SEE ALSO"
XkbChangeMap (__libmansuffix__), XkbGetKeyboardByName (__libmansuffix__), XkbSetMap (__libmansuffix__), XRefreshKeyboardMapping (3X11)