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 .. c:function:: int ioctl( int fd, NET_GET_IF, struct dvb_net_if *net_if )
  19     :name: NET_GET_IF
  20
  21
  22 Arguments
  23 =========
  24
  25 ``fd``
  26     File descriptor returned by :ref:`open() <frontend_f_open>`.
  27
  28 ``net_if``
  29     pointer to struct :c:type:`dvb_net_if`
  30
  31
  32 Description
  33 ===========
  34
  35 The NET_GET_IF ioctl uses the interface number given by the struct
  36 :c:type:`dvb_net_if`::ifnum field and fills the content of
  37 struct :c:type:`dvb_net_if` with the packet ID and
  38 encapsulation type used on such interface. If the interface was not
  39 created yet with :ref:`NET_ADD_IF <net>`, it will return -1 and fill
  40 the ``errno`` with ``EINVAL`` error code.
  41
  42
  43 Return Value
  44 ============
  45
  46 On success 0 is returned, on error -1 and the ``errno`` variable is set
  47 appropriately. The generic error codes are described at the
  48 :ref:`Generic Error Codes <gen-errors>` chapter.