1.. Permission is granted to copy, distribute and/or modify this
2.. document under the terms of the GNU Free Documentation License,
3.. Version 1.1 or any later version published by the Free Software
4.. Foundation, with no Invariant Sections, no Front-Cover Texts
5.. and no Back-Cover Texts. A copy of the license is included at
6.. Documentation/userspace-api/media/fdl-appendix.rst.
7..
8.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10.. _FE_GET_EVENT:
11
12************
13FE_GET_EVENT
14************
15
16Name
17====
18
19FE_GET_EVENT
20
21.. attention:: This ioctl is deprecated.
22
23
24Synopsis
25========
26
27.. c:function:: int  ioctl(int fd, FE_GET_EVENT, struct dvb_frontend_event *ev)
28    :name: FE_GET_EVENT
29
30
31Arguments
32=========
33
34``fd``
35    File descriptor returned by :c:func:`open() <dvb-fe-open>`.
36
37``ev``
38    Points to the location where the event, if any, is to be stored.
39
40
41Description
42===========
43
44This ioctl call returns a frontend event if available. If an event is
45not available, the behavior depends on whether the device is in blocking
46or non-blocking mode. In the latter case, the call fails immediately
47with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until
48an event becomes available.
49
50
51Return Value
52============
53
54On success 0 is returned.
55
56On error -1 is returned, and the ``errno`` variable is set
57appropriately.
58
59
60.. flat-table::
61    :header-rows:  0
62    :stub-columns: 0
63
64
65    -  .. row 1
66
67       -  ``EWOULDBLOCK``
68
69       -  There is no event pending, and the device is in non-blocking mode.
70
71    -  .. row 2
72
73       -  ``EOVERFLOW``
74
75       -  Overflow in event queue - one or more events were lost.
76
77Generic error codes are described at the
78:ref:`Generic Error Codes <gen-errors>` chapter.
79