Documentation/userspace-api/media/dvb/net-get-if.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.net
   3
   4 .. _NET_GET_IF:
   5
   6 ****************
   7 ioctl NET_GET_IF
   8 ****************
   9
  10 Name
  11 ====
  12
  13 NET_GET_IF - Read the configuration data of an interface created via - :ref:`NET_ADD_IF <net>`.
  14
  15 Synopsis
  16 ========
  17
  18 .. c:macro:: NET_GET_IF
  19
  20 ``int ioctl(int fd, NET_GET_IF, struct dvb_net_if *net_if)``
  21
  22 Arguments
  23 =========
  24
  25 ``fd``
  26     File descriptor returned by :c:func:`open()`.
  27
  28 ``net_if``
  29     pointer to struct :c:type:`dvb_net_if`
  30
  31 Description
  32 ===========
  33
  34 The NET_GET_IF ioctl uses the interface number given by the struct
  35 :c:type:`dvb_net_if`::ifnum field and fills the content of
  36 struct :c:type:`dvb_net_if` with the packet ID and
  37 encapsulation type used on such interface. If the interface was not
  38 created yet with :ref:`NET_ADD_IF <net>`, it will return -1 and fill
  39 the ``errno`` with ``EINVAL`` error code.
  40
  41 Return Value
  42 ============
  43
  44 On success 0 is returned, and :c:type:`ca_slot_info` is filled.
  45
  46 On error -1 is returned, and the ``errno`` variable is set
  47 appropriately.
  48
  49 The generic error codes are described at the
  50 :ref:`Generic Error Codes <gen-errors>` chapter.