Documentation/media/uapi/dvb/dmx-get-event.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _DMX_GET_EVENT:
   4
   5 =============
   6 DMX_GET_EVENT
   7 =============
   8
   9 Name
  10 ----
  11
  12 DMX_GET_EVENT
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. c:function:: int ioctl( int fd, DMX_GET_EVENT, struct dmx_event *ev)
  19     :name: DMX_GET_EVENT
  20
  21
  22 Arguments
  23 ---------
  24
  25 ``fd``
  26     File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
  27
  28 ``ev``
  29     Pointer to the location where the event is to be stored.
  30
  31
  32 Description
  33 -----------
  34
  35 This ioctl call returns an event if available. If an event is not
  36 available, the behavior depends on whether the device is in blocking or
  37 non-blocking mode. In the latter case, the call fails immediately with
  38 errno set to ``EWOULDBLOCK``. In the former case, the call blocks until an
  39 event becomes available.
  40
  41
  42 Return Value
  43 ------------
  44
  45 On success 0 is returned, on error -1 and the ``errno`` variable is set
  46 appropriately. The generic error codes are described at the
  47 :ref:`Generic Error Codes <gen-errors>` chapter.
  48
  49
  50
  51 .. flat-table::
  52     :header-rows:  0
  53     :stub-columns: 0
  54
  55
  56     -  .. row 1
  57
  58        -  ``EWOULDBLOCK``
  59
  60        -  There is no event pending, and the device is in non-blocking mode.