fe-get-event.rst (1333B)
1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later 2.. c:namespace:: DTV.fe 3 4.. _FE_GET_EVENT: 5 6************ 7FE_GET_EVENT 8************ 9 10Name 11==== 12 13FE_GET_EVENT 14 15.. attention:: This ioctl is deprecated. 16 17Synopsis 18======== 19 20.. c:macro:: FE_GET_EVENT 21 22``int ioctl(int fd, FE_GET_EVENT, struct dvb_frontend_event *ev)`` 23 24Arguments 25========= 26 27``fd`` 28 File descriptor returned by :c:func:`open()`. 29 30``ev`` 31 Points to the location where the event, if any, is to be stored. 32 33Description 34=========== 35 36This ioctl call returns a frontend event if available. If an event is 37not available, the behavior depends on whether the device is in blocking 38or non-blocking mode. In the latter case, the call fails immediately 39with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until 40an event becomes available. 41 42Return Value 43============ 44 45On success 0 is returned. 46 47On error -1 is returned, and the ``errno`` variable is set 48appropriately. 49 50.. flat-table:: 51 :header-rows: 0 52 :stub-columns: 0 53 54 - .. row 1 55 56 - ``EWOULDBLOCK`` 57 58 - There is no event pending, and the device is in non-blocking mode. 59 60 - .. row 2 61 62 - ``EOVERFLOW`` 63 64 - Overflow in event queue - one or more events were lost. 65 66Generic error codes are described at the 67:ref:`Generic Error Codes <gen-errors>` chapter.