media: docs: split uAPI info from imx.rst
[linux-block.git] / Documentation / media / uapi / dvb / dmx-stop.rst
CommitLineData
82559ac0
MCC
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
47d23e36
MCC
10.. _DMX_STOP:
11
586027ce 12========
47d23e36
MCC
13DMX_STOP
14========
15
15e7d615 16Name
586027ce 17----
47d23e36 18
586027ce 19DMX_STOP
47d23e36 20
15e7d615
MCC
21
22Synopsis
47d23e36
MCC
23--------
24
cf8076c3
MCC
25.. c:function:: int ioctl( int fd, DMX_STOP)
26 :name: DMX_STOP
47d23e36 27
47d23e36 28
15e7d615 29Arguments
586027ce 30---------
47d23e36 31
cf8076c3
MCC
32``fd``
33 File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
47d23e36 34
15e7d615 35Description
586027ce
MCC
36-----------
37
38This ioctl call is used to stop the actual filtering operation defined
883dfe8a
MCC
39via the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER` and
40started via the :ref:`DMX_START` command.
586027ce
MCC
41
42
15e7d615 43Return Value
47d23e36
MCC
44------------
45
9a721b9b
MCC
46On success 0 is returned.
47
48On error -1 is returned, and the ``errno`` variable is set
49appropriately.
50
51The generic error codes are described at the
47d23e36 52:ref:`Generic Error Codes <gen-errors>` chapter.