XkbFreeControls.man revision 1ab64890 
 t
 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.

 XkbFreeControls __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
 NAME
XkbFreeControls - Frees memory used by the ctrls member of an XkbDescRec structure

 SYNOPSIS
 void XkbFreeControls (
 xkb,  which,  free_all )


 XkbDescPtr xkb\^;


 unsigned int which\^;


 Bool free_all\^;

 ARGUMENTS

 - xkb Xkb description in which to free controls components


 - which mask of components of ctrls to free


 - free_all True => free everything + ctrls itself

 DESCRIPTION

 XkbFreeControls  frees the specified components of the 
 ctrls  field in the 
 xkb  keyboard description and sets the corresponding structure component values to NULL or zero. The 
 which  mask specifies the fields of 
 ctrls  to be freed and can contain any of the controls components specified in Table 1.

Table 1 shows the actual values for the individual mask bits used to select 
controls for 
modification and to enable and disable the control. Note that the same mask bit 
is used to 
specify general modifications to the parameters used to configure the control 
(which), and to 
enable and disable the control (enabled_ctrls). The anomalies in the table (no 
"ok" in column) 
are for controls that have no configurable attributes; and for controls that are 
not boolean 
controls and therefore cannot be enabled or disabled.





















 
 
 
 
 
 
 
 
 

 
 
 



 free_all  is True, 
 XkbFreeControls  frees every non-NULL structure component in the controls, frees the XkbControlsRec structure referenced by the 
 ctrls  member of 
 xkb,  and sets 
 ctrls  to NULL.