0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: DTV.fe
0003
0004 .. _FE_GET_EVENT:
0005
0006 ************
0007 FE_GET_EVENT
0008 ************
0009
0010 Name
0011 ====
0012
0013 FE_GET_EVENT
0014
0015 .. attention:: This ioctl is deprecated.
0016
0017 Synopsis
0018 ========
0019
0020 .. c:macro:: FE_GET_EVENT
0021
0022 ``int ioctl(int fd, FE_GET_EVENT, struct dvb_frontend_event *ev)``
0023
0024 Arguments
0025 =========
0026
0027 ``fd``
0028 File descriptor returned by :c:func:`open()`.
0029
0030 ``ev``
0031 Points to the location where the event, if any, is to be stored.
0032
0033 Description
0034 ===========
0035
0036 This ioctl call returns a frontend event if available. If an event is
0037 not available, the behavior depends on whether the device is in blocking
0038 or non-blocking mode. In the latter case, the call fails immediately
0039 with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until
0040 an event becomes available.
0041
0042 Return Value
0043 ============
0044
0045 On success 0 is returned.
0046
0047 On error -1 is returned, and the ``errno`` variable is set
0048 appropriately.
0049
0050 .. flat-table::
0051 :header-rows: 0
0052 :stub-columns: 0
0053
0054 - .. row 1
0055
0056 - ``EWOULDBLOCK``
0057
0058 - There is no event pending, and the device is in non-blocking mode.
0059
0060 - .. row 2
0061
0062 - ``EOVERFLOW``
0063
0064 - Overflow in event queue - one or more events were lost.
0065
0066 Generic error codes are described at the
0067 :ref:`Generic Error Codes <gen-errors>` chapter.
