t
 Copyright (c) 1999, Oracle and/or its affiliates.

 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, sublicense,
 and/or sell copies of the Software, and to permit persons to whom the
 Software is furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice (including the next
 paragraph) shall be included in all copies or substantial portions of the
 Software.

 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. IN NO EVENT SHALL
 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.

 XkbGetControls __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
 NAME
XkbGetControls - Finds the current state of Xkb server controls

 SYNOPSIS

 Status XkbGetControls  "(\^Display *" "display" "\^,"  "unsigned long " "which" "\^,"  "XkbDescPtr " "xkb" "\^);" 
 ARGUMENTS

 display connection to X server


 which mask of controls requested


 xkb keyboard description for controls information

 DESCRIPTION

 XkbGetControls  queries the server for the requested control information, waits for a reply, and 
then copies the server's values for the requested information into the 
 ctrls  structure of the 
 xkb  argument. Only those components specified by the 
 which  parameter are copied. Valid values for 
 which  are any combination of the masks listed in Table 1 that have "ok" in the
 which  column.

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 Table 1 (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.





















 
 
 
 
 
 
 
 
 

 
 
 




 xkb->ctrls  is NULL, 
 XkbGetControls  allocates and initializes it before obtaining the values specified by 
 which.  If 
 xkb->ctrls  is not NULL, 
 XkbGetControls  modifies only those portions of 
 xkb->ctrls  corresponding to the values specified by 
 which. 
 XkbGetControls  returns Success if successful; otherwise, it returns BadAlloc if it cannot 
obtain sufficient storage, BadMatch if 
 xkb  is NULL or 
 which  is empty, or BadImplementation.

To free the 
 ctrls  member of a keyboard description, use 
 XkbFreeControls. 
The 
 num_groups  field in the 
 ctrls  structure is always filled in by 
 XkbGetControls,  regardless of which bits are selected by 
 which. 
 "RETURN VALUES"
 15
Success
The 
 XkbGetControls  function returns Success if successful.

 DIAGNOSTICS
 15
 BadAlloc Unable to allocate storage

 15
 BadImplementation Invalid reply from server

 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"
 XkbFreeControls (__libmansuffix__)