Documentation/media/uapi/dvb/fe-get-frontend.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _FE_GET_FRONTEND:
   4
   5 ***************
   6 FE_GET_FRONTEND
   7 ***************
   8
   9 Name
  10 ====
  11
  12 FE_GET_FRONTEND
  13
  14 .. attention:: This ioctl is deprecated.
  15
  16
  17 Synopsis
  18 ========
  19
  20 .. c:function:: int ioctl(int fd, FE_GET_FRONTEND, struct dvb_frontend_parameters *p)
  21     :name: FE_GET_FRONTEND
  22
  23
  24 Arguments
  25 =========
  26
  27 ``fd``
  28     File descriptor returned by :c:func:`open() <dvb-fe-open>`.
  29
  30
  31 ``p``
  32     Points to parameters for tuning operation.
  33
  34
  35 Description
  36 ===========
  37
  38 This ioctl call queries the currently effective frontend parameters. For
  39 this command, read-only access to the device is sufficient.
  40
  41
  42 Return Value
  43 ============
  44
  45 On success 0 is returned.
  46
  47 On error -1 is returned, and the ``errno`` variable is set
  48 appropriately.
  49
  50 .. flat-table::
  51     :header-rows:  0
  52     :stub-columns: 0
  53
  54
  55     -  .. row 1
  56
  57        -  ``EINVAL``
  58
  59        -  Maximum supported symbol rate reached.
  60
  61 Generic error codes are described at the
  62 :ref:`Generic Error Codes <gen-errors>` chapter.