Documentation/media/uapi/rc/lirc-set-rec-timeout-reports.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _lirc_set_rec_timeout_reports:
   4
   5 **********************************
   6 ioctl LIRC_SET_REC_TIMEOUT_REPORTS
   7 **********************************
   8
   9 Name
  10 ====
  11
  12 LIRC_SET_REC_TIMEOUT_REPORTS - enable or disable timeout reports for IR receive
  13
  14 Synopsis
  15 ========
  16
  17 .. c:function:: int ioctl( int fd, LIRC_SET_REC_TIMEOUT_REPORTS, __u32 *enable )
  18     :name: LIRC_SET_REC_TIMEOUT_REPORTS
  19
  20 Arguments
  21 =========
  22
  23 ``fd``
  24     File descriptor returned by open().
  25
  26 ``enable``
  27     enable = 1 means enable timeout report, enable = 0 means disable timeout
  28     reports.
  29
  30
  31 Description
  32 ===========
  33
  34 .. _lirc-mode2-timeout:
  35
  36 Enable or disable timeout reports for IR receive. By default, timeout reports
  37 should be turned off.
  38
  39 .. note::
  40
  41    This ioctl is only valid for :ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>`.
  42
  43
  44 Return Value
  45 ============
  46
  47 On success 0 is returned, on error -1 and the ``errno`` variable is set
  48 appropriately. The generic error codes are described at the
  49 :ref:`Generic Error Codes <gen-errors>` chapter.