Documentation/userspace-api/media/dvb/ca-get-slot-info.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.ca
   3
   4 .. _CA_GET_SLOT_INFO:
   5
   6 ================
   7 CA_GET_SLOT_INFO
   8 ================
   9
  10 Name
  11 ----
  12
  13 CA_GET_SLOT_INFO
  14
  15 Synopsis
  16 --------
  17
  18 .. c:macro:: CA_GET_SLOT_INFO
  19
  20 ``int ioctl(fd, CA_GET_SLOT_INFO, struct ca_slot_info *info)``
  21
  22 Arguments
  23 ---------
  24
  25 ``fd``
  26   File descriptor returned by a previous call to :c:func:`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 Return Value
  38 ------------
  39
  40 On success 0 is returned, and :c:type:`ca_slot_info` is filled.
  41
  42 On error -1 is returned, and the ``errno`` variable is set
  43 appropriately.
  44
  45 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
  46
  47 .. flat-table::
  48     :header-rows:  0
  49     :stub-columns: 0
  50     :widths: 1 16
  51
  52     -  -  ``ENODEV``
  53        -  the slot is not available.
  54
  55 The generic error codes are described at the
  56 :ref:`Generic Error Codes <gen-errors>` chapter.