Commit | Line | Data |
---|---|---|
98a7b04e MCC |
1 | .. -*- coding: utf-8; mode: rst -*- |
2 | ||
3 | .. _lirc_set_rec_timeout: | |
4 | ||
5 | ************************** | |
6 | ioctl LIRC_SET_REC_TIMEOUT | |
7 | ************************** | |
8 | ||
9 | Name | |
10 | ==== | |
11 | ||
12 | LIRC_SET_REC_TIMEOUT - sets the integer value for IR inactivity timeout. | |
13 | ||
14 | Synopsis | |
15 | ======== | |
16 | ||
15c19014 MCC |
17 | .. c:function:: int ioctl( int fd, LIRC_SET_REC_TIMEOUT, __u32 *timeout ) |
18 | :name: LIRC_SET_REC_TIMEOUT | |
98a7b04e MCC |
19 | |
20 | Arguments | |
21 | ========= | |
22 | ||
23 | ``fd`` | |
24 | File descriptor returned by open(). | |
25 | ||
98a7b04e MCC |
26 | ``timeout`` |
27 | Timeout, in microseconds. | |
28 | ||
29 | ||
30 | Description | |
31 | =========== | |
32 | ||
33 | Sets the integer value for IR inactivity timeout. | |
34 | ||
35 | If supported by the hardware, setting it to 0 disables all hardware timeouts | |
36 | and data should be reported as soon as possible. If the exact value | |
37 | cannot be set, then the next possible value _greater_ than the | |
38 | given value should be set. | |
39 | ||
40 | .. note:: | |
41 | ||
42 | The range of supported timeout is given by :ref:`LIRC_GET_MIN_TIMEOUT`. | |
43 | ||
44 | ||
45 | Return Value | |
46 | ============ | |
47 | ||
48 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
49 | appropriately. The generic error codes are described at the | |
50 | :ref:`Generic Error Codes <gen-errors>` chapter. |