Merge branch 'work.iget' into work.misc
[sfrench/cifs-2.6.git] / Documentation / media / uapi / dvb / dmx-remove-pid.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _DMX_REMOVE_PID:
4
5 ==============
6 DMX_REMOVE_PID
7 ==============
8
9 Name
10 ----
11
12 DMX_REMOVE_PID
13
14
15 Synopsis
16 --------
17
18 .. cpp:function:: int ioctl(fd, int request = DMX_REMOVE_PID, __u16 *)
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_REMOVE_PID for this command.
40
41     -  .. row 3
42
43        -  __u16 *
44
45        -  PID of the PES filter to be removed.
46
47
48 Description
49 -----------
50
51 This ioctl call allows to remove a PID when multiple PIDs are set on a
52 transport stream filter, e. g. a filter previously set up with output
53 equal to DMX_OUT_TSDEMUX_TAP, created via either
54 DMX_SET_PES_FILTER or DMX_ADD_PID.
55
56
57 Return Value
58 ------------
59
60 On success 0 is returned, on error -1 and the ``errno`` variable is set
61 appropriately. The generic error codes are described at the
62 :ref:`Generic Error Codes <gen-errors>` chapter.