@CHIP-RTOS C Library - TCP/IP API

Dev_UnConfig_Iface

Remove IPv4 or IPv6 device configuration

int Dev_UnConfig_Iface( DevUserIfaceHandle DevHandlePtr,
                        unsigned int proto,
                        unsigned char mHomeIndex,
                        int *error);

Parameters

DevHandlePtr

Device handle

proto

Protocol family AF_INET or AF_INET6

mHomeIndex

Multi home index number of the device

error

Output parameter:  Failure code, 0 on success.

Return Value

0: success,
-1: failed

Comments

Remove an IP configuration from an interface for a particular multi home index

RTOS API

This library function invokes a RTOS software interrupt. Refer to this RTOS API function's documentation for more details.

On SC1x3/SC2x (RTOS version >=1.13, CLIB version >=2.10) there's also a version of this function which uses dynamic linking instead of a software interrupt, which reduces the function's overhead and thus speeds up your application. This function's name is Dev_UnConfig_Iface_Dyn. You should however not use this function directly. Instead you should add the define TCPIP_DYN_LINK_DEV to your program before including the CLIB's header file(s):

#define TCPIP_DYN_LINK_DEV
#include <clib.h>

This will map the original function's name to the dynamic linking version. This way you can also easily switch existing programs to dynamic linking.

Related Topics

TCP/IP Device Driver overview

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.20	V1.20	V1.20	V1.10	V1.00

Supported by @CHIP-RTOS C Library since version

CLIB
V2.04