xref: /linux/Documentation/userspace-api/media/dvb/net-get-if.rst (revision 2c739ced5886cd8c8361faa79a9522ec05174ed0)
1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
3.. _NET_GET_IF:
4
5****************
6ioctl NET_GET_IF
7****************
8
9Name
10====
11
12NET_GET_IF - Read the configuration data of an interface created via - :ref:`NET_ADD_IF <net>`.
13
14
15Synopsis
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
22Arguments
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
32Description
33===========
34
35The 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
37struct :c:type:`dvb_net_if` with the packet ID and
38encapsulation type used on such interface. If the interface was not
39created yet with :ref:`NET_ADD_IF <net>`, it will return -1 and fill
40the ``errno`` with ``EINVAL`` error code.
41
42
43Return Value
44============
45
46On success 0 is returned, and :c:type:`ca_slot_info` is filled.
47
48On error -1 is returned, and the ``errno`` variable is set
49appropriately.
50
51The generic error codes are described at the
52:ref:`Generic Error Codes <gen-errors>` chapter.
53