Documentation/media/uapi/dvb/dmx-stop.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _DMX_STOP:
  11
  12 ========
  13 DMX_STOP
  14 ========
  15
  16 Name
  17 ----
  18
  19 DMX_STOP
  20
  21
  22 Synopsis
  23 --------
  24
  25 .. c:function:: int ioctl( int fd, DMX_STOP)
  26     :name: DMX_STOP
  27
  28
  29 Arguments
  30 ---------
  31
  32 ``fd``
  33     File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
  34
  35 Description
  36 -----------
  37
  38 This ioctl call is used to stop the actual filtering operation defined
  39 via the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER` and
  40 started via the :ref:`DMX_START` command.
  41
  42
  43 Return Value
  44 ------------
  45
  46 On success 0 is returned.
  47
  48 On error -1 is returned, and the ``errno`` variable is set
  49 appropriately.
  50
  51 The generic error codes are described at the
  52 :ref:`Generic Error Codes <gen-errors>` chapter.