net-remove-if.rst

 1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
 2.. c:namespace:: DTV.net
 3
 4.. _NET_REMOVE_IF:
 5
 6*******************
 7ioctl NET_REMOVE_IF
 8*******************
 9
10Name
11====
12
13NET_REMOVE_IF - Removes a network interface.
14
15Synopsis
16========
17
18.. c:macro:: NET_REMOVE_IF
19
20``int ioctl(int fd, NET_REMOVE_IF, int ifnum)``
21
22Arguments
23=========
24
25``fd``
26    File descriptor returned by :c:func:`open()`.
27
28``net_if``
29    number of the interface to be removed
30
31Description
32===========
33
34The NET_REMOVE_IF ioctl deletes an interface previously created via
35:ref:`NET_ADD_IF <net>`.
36
37Return Value
38============
39
40On success 0 is returned, and :c:type:`ca_slot_info` is filled.
41
42On error -1 is returned, and the ``errno`` variable is set
43appropriately.
44
45The generic error codes are described at the
46:ref:`Generic Error Codes <gen-errors>` chapter.