[media] docs-rst: Convert DVB uAPI to use C function references
[linux-2.6-block.git] / Documentation / media / uapi / dvb / dmx-add-pid.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _DMX_ADD_PID:
4
586027ce 5===========
47d23e36
MCC
6DMX_ADD_PID
7===========
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12DMX_ADD_PID
47d23e36 13
15e7d615
MCC
14
15Synopsis
47d23e36
MCC
16--------
17
cf8076c3
MCC
18.. c:function:: int ioctl(fd, DMX_ADD_PID, __u16 *pid)
19 :name: DMX_ADD_PID
47d23e36 20
47d23e36 21
15e7d615 22Arguments
586027ce 23---------
47d23e36 24
cf8076c3
MCC
25``fd``
26 File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
47d23e36 27
cf8076c3
MCC
28``pid``
29 PID number to be filtered.
47d23e36
MCC
30
31
15e7d615 32Description
586027ce
MCC
33-----------
34
35This ioctl call allows to add multiple PIDs to a transport stream filter
36previously set up with DMX_SET_PES_FILTER and output equal to
37DMX_OUT_TSDEMUX_TAP.
38
39
15e7d615 40Return Value
47d23e36
MCC
41------------
42
43On success 0 is returned, on error -1 and the ``errno`` variable is set
44appropriately. The generic error codes are described at the
45:ref:`Generic Error Codes <gen-errors>` chapter.