| David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame^] | 1 | .. Permission is granted to copy, distribute and/or modify this |
| 2 | .. document under the terms of the GNU Free Documentation License, |
| 3 | .. Version 1.1 or any later version published by the Free Software |
| 4 | .. Foundation, with no Invariant Sections, no Front-Cover Texts |
| 5 | .. and no Back-Cover Texts. A copy of the license is included at |
| 6 | .. Documentation/media/uapi/fdl-appendix.rst. |
| 7 | .. |
| 8 | .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections |
| Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 9 | |
| 10 | .. _NET_REMOVE_IF: |
| 11 | |
| 12 | ******************* |
| 13 | ioctl NET_REMOVE_IF |
| 14 | ******************* |
| 15 | |
| 16 | Name |
| 17 | ==== |
| 18 | |
| 19 | NET_REMOVE_IF - Removes a network interface. |
| 20 | |
| 21 | |
| 22 | Synopsis |
| 23 | ======== |
| 24 | |
| 25 | .. c:function:: int ioctl( int fd, NET_REMOVE_IF, int ifnum ) |
| 26 | :name: NET_REMOVE_IF |
| 27 | |
| 28 | |
| 29 | Arguments |
| 30 | ========= |
| 31 | |
| 32 | ``fd`` |
| 33 | File descriptor returned by :ref:`open() <frontend_f_open>`. |
| 34 | |
| 35 | ``net_if`` |
| 36 | number of the interface to be removed |
| 37 | |
| 38 | |
| 39 | Description |
| 40 | =========== |
| 41 | |
| 42 | The NET_REMOVE_IF ioctl deletes an interface previously created via |
| 43 | :ref:`NET_ADD_IF <net>`. |
| 44 | |
| 45 | |
| 46 | Return Value |
| 47 | ============ |
| 48 | |
| 49 | On success 0 is returned, and :c:type:`ca_slot_info` is filled. |
| 50 | |
| 51 | On error -1 is returned, and the ``errno`` variable is set |
| 52 | appropriately. |
| 53 | |
| 54 | The generic error codes are described at the |
| 55 | :ref:`Generic Error Codes <gen-errors>` chapter. |