fe-get-event.rst 1.3 KB

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