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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _CA_SET_PID:
   4
   5 ==========
   6 CA_SET_PID
   7 ==========
   8
   9 Name
  10 ----
  11
  12 CA_SET_PID
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. c:function:: int ioctl(fd, CA_SET_PID, struct ca_pid *pid)
  19     :name: CA_SET_PID
  20
  21
  22 Arguments
  23 ---------
  24
  25 ``fd``
  26   File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
  27
  28 ``pid``
  29   Pointer to struct :c:type:`ca_pid`.
  30
  31 .. c:type:: ca_pid
  32
  33 .. flat-table:: struct ca_pid
  34     :header-rows:  1
  35     :stub-columns: 0
  36
  37     -
  38        - unsigned int
  39        - pid
  40        - Program ID
  41
  42     -
  43        - int
  44        - index
  45        - PID index. Use -1 to disable.
  46
  47
  48
  49 Description
  50 -----------
  51
  52 .. note:: This ioctl is undocumented. Documentation is welcome.
  53
  54
  55 Return Value
  56 ------------
  57
  58 On success 0 is returned, on error -1 and the ``errno`` variable is set
  59 appropriately. The generic error codes are described at the
  60 :ref:`Generic Error Codes <gen-errors>` chapter.