man/xkb/XkbFreeKeyboard.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 XkbFreeKeyboard __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbFreeKeyboard \-  Destroys either an entire XkbDescRec or just some of its
  25 members
  26 .SH SYNOPSIS
  27 .HP
  28 .B void XkbFreeKeyboard
  29 .BI "(\^XkbDescPtr " "xkb" "\^,"
  30 .BI "unsigned int " "which" "\^,"
  31 .BI "Bool " "free_all" "\^);"
  32 .if n .ti +5n
  33 .if t .ti +.5i
  34 .SH ARGUMENTS
  35 .TP
  36 .I xkb
  37 keyboard description with components to free
  38 .TP
  39 .I which
  40 mask selecting components to free
  41 .TP
  42 .I free_all
  43 True => free all components and
  44 .I xkb
  45 .SH DESCRIPTION
  46 .LP
  47 .I XkbFreeKeyboard
  48 frees the components of
  49 .I xkb
  50 specified by
  51 .I which
  52 and sets the corresponding values to NULL. If
  53 .I
  54 free_all
  55 is True,
  56 .I XkbFreeKeyboard
  57 frees every non-NULL component of
  58 .I xkb
  59 and then frees the
  60 .I xkb
  61 structure itself.
  62