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

NAME

6       XkbGetDeviceLedInfo  - Query the indicator names, maps, and state asso‐
7       ciated with an LED feedback of an input extension device
8

SYNOPSIS

10       Status XkbGetDeviceLedInfo (Display *dpy, XkbDeviceInfoPtr device_info,
11              unsigned  int  led_class,  unsigned  int  led_id,  unsigned  int
12              which);
13

ARGUMENTS

15       dpy    connection to X server
16
17       device_info
18              structure to update with results
19
20       led_class
21              LED feedback class assigned by input extension
22
23       led_id LED feedback ID assigned by input extension
24
25       which  mask indicating desired information
26

DESCRIPTION

28       XkbGetDeviceLedInfo queries the server for the desired LED  information
29       for  the feedback specified by led_class and led_id for the X input ex‐
30       tension device indicated by device_spec->device_info and  waits  for  a
31       reply. If successful, XkbGetDeviceLedInfo backfills the relevant fields
32       of device_info as determined by which with the results and returns Suc‐
33       cess. Valid values for which are the inclusive OR of any of XkbXI_Indi‐
34       catorNamesMask, XkbXI_IndicatorMapsMask, and XkbXI_IndicatorStateMask.
35
36       The fields of device_info that are filled in when this request succeeds
37       are  name,  type,  supported, and unsupported, and portions of the leds
38       structure corresponding to led_class and led_id  as  indicated  by  the
39       bits set in which.  The device_info->leds vector is allocated if neces‐
40       sary and sz_leds and num_leds filled  in.  The  led_class,  led_id  and
41       phys_indicators  fields of the device_info->leds entry corresponding to
42       led_class and led_id are always filled in.
43
44       If which contains XkbXI_IndicatorNamesMask, the names_present and names
45       fields  of  the  device_info->leds structure corresponding to led_class
46       and led_id are updated, if which contains XkbXI_IndicatorStateMask, the
47       corresponding state field is updated, and if which contains XkbXI_Indi‐
48       catorMapsMask, the maps_present and maps fields are updated.
49
50       If a compatible version of Xkb is not available in the  server  or  the
51       Xkb  extension  has  not been properly initialized, XkbGetDeviceLedInfo
52       returns BadAccess. If allocation errors occur, a BadAlloc status is re‐
53       turned.  If the device has no indicators, a BadMatch error is returned.
54       If ledClass or ledID have illegal values, a BadValue error is returned.
55       If  they  have legal values but do not specify a feedback that contains
56       LEDs and is associated with the specified device, a BadMatch  error  is
57       returned.
58

DIAGNOSTICS

60       BadAccess      The Xkb extension has not been properly initialized
61
62       BadAlloc       Unable to allocate storage
63
64       BadMatch       A  compatible  version  of  Xkb was not available in the
65                      server or an argument has correct type and range, but is
66                      otherwise invalid
67
68       BadValue       An argument is out of range
69
70
71
72X Version 11                     libX11 1.8.7           XkbGetDeviceLedInfo(3)
Impressum