Documentation/media/uapi/dvb/net-get-if.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 .. _NET_GET_IF:
  11
  12 ****************
  13 ioctl NET_GET_IF
  14 ****************
  15
  16 Name
  17 ====
  18
  19 NET_GET_IF - Read the configuration data of an interface created via - :ref:`NET_ADD_IF <net>`.
  20
  21
  22 Synopsis
  23 ========
  24
  25 .. c:function:: int ioctl( int fd, NET_GET_IF, struct dvb_net_if *net_if )
  26     :name: NET_GET_IF
  27
  28
  29 Arguments
  30 =========
  31
  32 ``fd``
  33     File descriptor returned by :ref:`open() <frontend_f_open>`.
  34
  35 ``net_if``
  36     pointer to struct :c:type:`dvb_net_if`
  37
  38
  39 Description
  40 ===========
  41
  42 The NET_GET_IF ioctl uses the interface number given by the struct
  43 :c:type:`dvb_net_if`::ifnum field and fills the content of
  44 struct :c:type:`dvb_net_if` with the packet ID and
  45 encapsulation type used on such interface. If the interface was not
  46 created yet with :ref:`NET_ADD_IF <net>`, it will return -1 and fill
  47 the ``errno`` with ``EINVAL`` error code.
  48
  49
  50 Return Value
  51 ============
  52
  53 On success 0 is returned, and :c:type:`ca_slot_info` is filled.
  54
  55 On error -1 is returned, and the ``errno`` variable is set
  56 appropriately.
  57
  58 The generic error codes are described at the
  59 :ref:`Generic Error Codes <gen-errors>` chapter.