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    connection to X server
15
16       auto_ctrls
17              specifies which bits in auto_values are relevant
18
19       auto_values
20              1 bit => corresponding control has auto-reset on
21

DESCRIPTION

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

RETURN VALUES

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