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

49 lines
1.0 KiB
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _NET_GET_IF:
****************
ioctl NET_GET_IF
****************
Name
====
NET_GET_IF - Read the configuration data of an interface created via - :ref:`NET_ADD_IF <net>`.
Synopsis
========
.. c:function:: int ioctl( int fd, NET_GET_IF, struct dvb_net_if *net_if )
:name: NET_GET_IF
Arguments
=========
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``net_if``
pointer to struct :c:type:`dvb_net_if`
Description
===========
The NET_GET_IF ioctl uses the interface number given by the struct
:c:type:`dvb_net_if`::ifnum field and fills the content of
struct :c:type:`dvb_net_if` with the packet ID and
encapsulation type used on such interface. If the interface was not
created yet with :ref:`NET_ADD_IF <net>`, it will return -1 and fill
the ``errno`` with ``EINVAL`` error code.
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.