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

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