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 .. cpp:function:: int ioctl( int fd, int request = DMX_GET_EVENT, struct dmx_event *ev)
  19
  20
  21 Arguments
  22 ---------
  23
  24 .. flat-table::
  25     :header-rows:  0
  26     :stub-columns: 0
  27
  28
  29     -  .. row 1
  30
  31        -  int fd
  32
  33        -  File descriptor returned by a previous call to open().
  34
  35     -  .. row 2
  36
  37        -  int request
  38
  39        -  Equals DMX_GET_EVENT for this command.
  40
  41     -  .. row 3
  42
  43        -  struct dmx_event \*ev
  44
  45        -  Pointer to the location where the event is to be stored.
  46
  47
  48 Description
  49 -----------
  50
  51 This ioctl call returns an event if available. If an event is not
  52 available, the behavior depends on whether the device is in blocking or
  53 non-blocking mode. In the latter case, the call fails immediately with
  54 errno set to ``EWOULDBLOCK``. In the former case, the call blocks until an
  55 event becomes available.
  56
  57
  58 Return Value
  59 ------------
  60
  61 On success 0 is returned, on error -1 and the ``errno`` variable is set
  62 appropriately. The generic error codes are described at the
  63 :ref:`Generic Error Codes <gen-errors>` chapter.
  64
  65
  66
  67 .. flat-table::
  68     :header-rows:  0
  69     :stub-columns: 0
  70
  71
  72     -  .. row 1
  73
  74        -  ``EWOULDBLOCK``
  75
  76        -  There is no event pending, and the device is in non-blocking mode.