XkbGetDeviceLedInfo - Query the indicator names, maps, and state associated with an LED feedback of an input extension device


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


  • - dpy
        connection to X server
  • - device_info
        structure to update with results
  • - led_class
        LED feedback class assigned by input extension
  • - led_id
        LED feedback ID assigned by input extension
  • - which
        mask indicating desired information


XkbGetDeviceLedInfoqueries the server for the desired LED information for the feedback specified by led_classand led_idfor the X input extension device indicated by device_spec->device_infoand waits for a reply. If successful, XkbGetDeviceLedInfobackfills the relevant fields of device_infoas determined by whichwith the results and returns Success. Valid values for whichare the inclusive OR of any of XkbXI_IndicatorNamesMask, XkbXI_IndicatorMapsMask, and XkbXI_IndicatorStateMask. The fields of device_infothat are filled in when this request succeeds are name, type, supported,and unsupported,and portions of the ledsstructure corresponding to led_classand led_idas indicated by the bits set in which.The device_info->ledsvector is allocated if necessary and sz_ledsand num_ledsfilled in. The led_class, led_idand phys_indicatorsfields of the device_info->ledsentry corresponding to led_classand led_idare always filled in. If whichcontains XkbXI_IndicatorNamesMask, the names_presentand namesfields of the device_info->ledsstructure corresponding to led_classand led_idare updated, if whichcontains XkbXI_IndicatorStateMask, the corresponding statefield is updated, and if whichcontains XkbXI_IndicatorMapsMask, the maps_presentand mapsfields are updated. If a compatible version of Xkb is not available in the server or the Xkb extension has not been properly initialized, XkbGetDeviceLedInforeturns BadAccess. If allocation errors occur, a BadAlloc status is returned. If the device has no indicators, a BadMatch error is returned. If ledClassor ledIDhave illegal values, a BadValue error is returned. If they have legal values but do not specify a feedback that contains LEDs and is associated with the specified device, a BadMatch error is returned.



               The Xkb extension has not been properly initialized


               Unable to allocate storage


               A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid


               An argument is out of range