linux/Documentation/media/uapi/dvb/ca-set-pid.rst

61 lines
904 B
ReStructuredText
Raw Normal View History

.. -*- coding: utf-8; mode: rst -*-
.. _CA_SET_PID:
==========
CA_SET_PID
==========
Name
----
CA_SET_PID
Synopsis
--------
.. c:function:: int ioctl(fd, CA_SET_PID, struct ca_pid *pid)
:name: CA_SET_PID
Arguments
---------
``fd``
File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
``pid``
Pointer to struct :c:type:`ca_pid`.
.. c:type:: ca_pid
.. flat-table:: struct ca_pid
:header-rows: 1
:stub-columns: 0
-
- unsigned int
- pid
- Program ID
-
- int
- index
- PID index. Use -1 to disable.
Description
-----------
.. note:: This ioctl is undocumented. Documentation is welcome.
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.