Jump to main content

##

# TCPIP_IPV6_RouterAddressAdd Function

## C

    bool TCPIP_IPV6_RouterAddressAdd(
        TCPIP_NET_HANDLE netH,
        IPV6_ADDR * rAddress,
        unsigned long validTime,
        int flags
    );

## Description

This function adds a unicast address as a routing address to a specified interface.

## Preconditions

rAddress - pointer to a valid IPv6 router address, IPv6 stack initialized, and interface up and configured.

## Parameters

Parameters | Description
--- | ---
netH | The interface to which the address is to be added.
rAddress | The router address to add.
validTime | The time this entry will be valid, in seconds. If 0, the entry will be valid forever.
flags | Creation flags (not used for now, should be 0).

## Returns

- True - operation succeeded.
- False - Operation failed (interface not valid, interface still configuring, no memory, etc. ).

## Remarks

The validTime parameter is relevant for an existent router on the network. If such router does not exist the stack will eventually discard the entry automatically.