man/xkb/XkbGetNameChanges.man

   1 '\" t
   2 .\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
   3 .\"
   4 .\" Permission is hereby granted, free of charge, to any person obtaining a
   5 .\" copy of this software and associated documentation files (the "Software"),
   6 .\" to deal in the Software without restriction, including without limitation
   7 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8 .\" and/or sell copies of the Software, and to permit persons to whom the
   9 .\" Software is furnished to do so, subject to the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice (including the next
  12 .\" paragraph) shall be included in all copies or substantial portions of the
  13 .\" Software.
  14 .\"
  15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21 .\" DEALINGS IN THE SOFTWARE.
  22 .\"
  23 .TH XkbGetNameChanges __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  24 .SH NAME
  25 XkbGetNameChanges \- Update the local copy of the keyboard description with the
  26 actual values of the results of one or more calls to
  27 .I XkbNoteNameChanges
  28 .SH SYNOPSIS
  29 .HP
  30 .B Status XkbGetNameChanges
  31 .BI "(\^Display *" "dpy" "\^,"
  32 .BI "XkbDescPtr " "xkb" "\^,"
  33 .BI "XkbNameChangesPtr " "changes" "\^);"
  34 .if n .ti +5n
  35 .if t .ti +.5i
  36 .SH ARGUMENTS
  37 .TP
  38 .I \- dpy
  39 connection to the X server
  40 .TP
  41 .I \- xkb
  42 keyboard description to which names are copied
  43 .TP
  44 .I \- changes
  45 names components to be obtained from the server
  46 .SH DESCRIPTION
  47 .LP
  48 .I XkbGetNameChanges
  49 examines the
  50 .I changes
  51 parameter, retrieves the necessary information from the server, and places the
  52 results into the
  53 .I xkb
  54 keyboard description.
  55
  56 .I XkbGetNamesChanges
  57 can generate BadAlloc, BadImplementation, and BadMatch errors.
  58 .SH DIAGNOSTICS
  59 .TP 15
  60 .B BadAlloc
  61 Unable to allocate storage
  62 .TP 15
  63 .B BadImplementation
  64 Invalid reply from server
  65 .TP 15
  66 .B BadMatch
  67 A compatible version of Xkb was not available in the server or an argument has
  68 correct type and range, but is otherwise invalid
  69 .SH "SEE ALSO"
  70 .BR XkbNoteNameChanges (__libmansuffix__)