man/xkb/XkbGetKeySyms.man

   1 .\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining a
   4 .\" copy of this software and associated documentation files (the "Software"),
   5 .\" to deal in the Software without restriction, including without limitation
   6 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   7 .\" and/or sell copies of the Software, and to permit persons to whom the
   8 .\" Software is furnished to do so, subject to the following conditions:
   9 .\"
  10 .\" The above copyright notice and this permission notice (including the next
  11 .\" paragraph) shall be included in all copies or substantial portions of the
  12 .\" Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20 .\" DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .TH XkbGetKeySyms __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbGetKeySyms \- Obtain the symbols for a subset of the keys in a keyboard
  25 description
  26 .SH SYNOPSIS
  27 .HP
  28 .B Status XkbGetKeySyms
  29 .BI "(\^Display *" "dpy" "\^,"
  30 .BI "unsigned int " "first" "\^,"
  31 .BI "unsigned int " "num" "\^,"
  32 .BI "XkbDescPtr " "xkb" "\^);"
  33 .if n .ti +5n
  34 .if t .ti +.5i
  35 .SH ARGUMENTS
  36 .TP
  37 .I \- dpy
  38 connection to X server
  39 .TP
  40 .I \- first
  41 keycode of first key to get
  42 .TP
  43 .I \- num
  44 number of keycodes for which syms desired
  45 .TP
  46 .I \- xkb
  47 Xkb description to be updated
  48 .SH DESCRIPTION
  49 .LP
  50 .I XkbGetKeySyms
  51 sends a request to the server to obtain the set of keysyms bound to
  52 .I num
  53 keys starting with the key whose keycode is
  54 .I first.
  55 It waits for a reply and returns the keysyms in the
  56 .I map.syms
  57 field of
  58 .I xkb.
  59 If successful,
  60 .I XkbGetKeySyms
  61 returns Success. The
  62 .I xkb
  63 parameter must be a pointer to a valid Xkb keyboard description.
  64
  65 If the client
  66 .I map
  67 in the xkb parameter has not been allocated,
  68 .I XkbGetKeySyms
  69 allocates and initializes it before obtaining the symbols.
  70
  71 If a compatible version of Xkb is not available in the server or the Xkb
  72 extension has not been properly initialized,
  73 .I XkbGetKeySyms
  74 returns BadAccess. If
  75 .I num
  76 is less than 1 or greater than XkbMaxKeyCount,
  77 .I XkbGetKeySyms
  78 returns BadValue. If any allocation errors occur,
  79 .I XkbGetKeySyms
  80 returns BadAlloc.
  81 .SH "RETURN VALUES"
  82 .TP 15
  83 Success
  84 The
  85 .I XkbGetKeySyms
  86 function returns Success if it gets a reply to a request to the server to obtain the set of keysyms bound to
  87 .I num
  88 keys starting with the key whose keycode is
  89 .I first.
  90 .SH DIAGNOSTICS
  91 .TP 15
  92 .B BadAccess
  93 The Xkb extension has not been properly initialized
  94 .TP 15
  95 .B BadAlloc
  96 Unable to allocate storage
  97 .TP 15
  98 .B BadValue
  99 An argument is out of range