Documentation/media/uapi/dvb/net-get-if.rst

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