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
24              LED feedback ID assigned by input extension
25
26       - which
27              mask indicating desired information
28

DESCRIPTION

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

DIAGNOSTICS

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