Commit | Line | Data |
---|---|---|
5377d91f MH |
1 | .. -*- coding: utf-8; mode: rst -*- |
2 | ||
3 | .. _FE_GET_EVENT: | |
4 | ||
5 | ************ | |
6 | FE_GET_EVENT | |
7 | ************ | |
8 | ||
15e7d615 | 9 | Name |
586027ce | 10 | ==== |
5377d91f | 11 | |
586027ce | 12 | FE_GET_EVENT |
5377d91f | 13 | |
cf8076c3 MCC |
14 | .. attention:: This ioctl is deprecated. |
15 | ||
15e7d615 MCC |
16 | |
17 | Synopsis | |
586027ce | 18 | ======== |
5377d91f | 19 | |
cf8076c3 MCC |
20 | .. c:function:: int ioctl(int fd, FE_GET_EVENT, struct dvb_frontend_event *ev) |
21 | :name: FE_GET_EVENT | |
5377d91f | 22 | |
5377d91f | 23 | |
15e7d615 | 24 | Arguments |
586027ce | 25 | ========= |
5377d91f | 26 | |
cf8076c3 MCC |
27 | ``fd`` |
28 | File descriptor returned by :c:func:`open() <dvb-fe-open>`. | |
5377d91f | 29 | |
cf8076c3 MCC |
30 | ``ev`` |
31 | Points to the location where the event, if any, is to be stored. | |
5377d91f MH |
32 | |
33 | ||
15e7d615 | 34 | Description |
586027ce MCC |
35 | =========== |
36 | ||
37 | This ioctl call returns a frontend event if available. If an event is | |
38 | not available, the behavior depends on whether the device is in blocking | |
39 | or non-blocking mode. In the latter case, the call fails immediately | |
40 | with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until | |
41 | an event becomes available. | |
42 | ||
43 | ||
15e7d615 | 44 | Return Value |
586027ce | 45 | ============ |
5377d91f MH |
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. | |
50 | ||
51 | ||
52 | ||
53 | .. flat-table:: | |
54 | :header-rows: 0 | |
55 | :stub-columns: 0 | |
56 | ||
57 | ||
58 | - .. row 1 | |
59 | ||
cdb4af0f | 60 | - ``EWOULDBLOCK`` |
5377d91f MH |
61 | |
62 | - There is no event pending, and the device is in non-blocking mode. | |
63 | ||
64 | - .. row 2 | |
65 | ||
cdb4af0f | 66 | - ``EOVERFLOW`` |
5377d91f MH |
67 | |
68 | - Overflow in event queue - one or more events were lost. |