1XkbGetAutoResetControls(3)       XKB FUNCTIONS      XkbGetAutoResetControls(3)
2
3
4

NAME

6       XkbGetAutoResetControls  -  Gets  the  current values of the auto-reset
7       controls
8

SYNOPSIS

10       Bool XkbGetAutoResetControls (Display *dpy, unsigned int   *auto_ctrls,
11              unsigned int  *auto_values);
12

ARGUMENTS

14       - dpy
15               connection to X server
16
17       - auto_ctrls
18               specifies which bits in auto_values are relevant
19
20       - auto_values
21              1 bit => corresponding control has auto-reset on
22

DESCRIPTION

24       You  can  configure the boolean controls to automatically be enabled or
25       disabled when a program exits. This capability is  controlled  via  two
26       masks  maintained  in  the  X server on a per-client basis. There is no
27       client-side Xkb data structure corresponding to these  masks.  Whenever
28       the  client exits for any reason, any boolean controls specified in the
29       auto-reset mask are set to the corresponding value from the  auto-reset
30       values  mask.  This  makes  it  possible for clients to "clean up after
31       themselves" automatically, even if abnormally terminated. The bits used
32       in the masks correspond to the EnabledControls control bits.
33
34       For  example,  a client that replaces the keyboard bell with some other
35       audible cue might want to turn off the AudibleBell control  to  prevent
36       the  server  from  also  generating a sound and avoid cacophony. If the
37       client were to exit without resetting the AudibleBell control, the user
38       would  be left without any feedback at all. Setting AudibleBell in both
39       the auto-reset mask and auto-reset values guarantees that  the  audible
40       bell will be turned back on when the client exits.
41
42       XkbGetAutoResetControls  backfills  auto_ctrls and auto_values with the
43       AutoReset control attributes for this  particular  client.  It  returns
44       True if successful, and False otherwise.
45

RETURN VALUES

47       True           The  XkbGetAutoResetControls  function returns True when
48                      it successfully  backfills  auto_ctrls  and  auto_values
49                      with  the AutoReset control attributes for this particu‐
50                      lar client.
51
52       False          The XkbGetAutoResetControls function returns False  when
53                      it   does   not  successfully  backfill  auto_ctrls  and
54                      auto_values with the AutoReset  control  attributes  for
55                      this particular client.
56
57
58
59X Version 11                     libX11 1.3.4       XkbGetAutoResetControls(3)
Impressum