fe-get-event.rst 1.3 KB

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