Documentation/media/uapi/dvb/ca-get-slot-info.rst

   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
  10 .. _CA_GET_SLOT_INFO:
  11
  12 ================
  13 CA_GET_SLOT_INFO
  14 ================
  15
  16 Name
  17 ----
  18
  19 CA_GET_SLOT_INFO
  20
  21
  22 Synopsis
  23 --------
  24
  25 .. c:function:: int ioctl(fd, CA_GET_SLOT_INFO, struct ca_slot_info *info)
  26     :name: CA_GET_SLOT_INFO
  27
  28
  29 Arguments
  30 ---------
  31
  32 ``fd``
  33   File descriptor returned by a previous call to :c:func:`open() <cec-open>`.
  34
  35 ``info``
  36   Pointer to struct :c:type:`ca_slot_info`.
  37
  38 Description
  39 -----------
  40
  41 Returns information about a CA slot identified by
  42 :c:type:`ca_slot_info`.slot_num.
  43
  44
  45 Return Value
  46 ------------
  47
  48 On success 0 is returned, and :c:type:`ca_slot_info` is filled.
  49
  50 On error -1 is returned, and the ``errno`` variable is set
  51 appropriately.
  52
  53 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
  54
  55 .. flat-table::
  56     :header-rows:  0
  57     :stub-columns: 0
  58     :widths: 1 16
  59
  60     -  -  ``ENODEV``
  61        -  the slot is not available.
  62
  63 The generic error codes are described at the
  64 :ref:`Generic Error Codes <gen-errors>` chapter.