tf6DelDefaultGateway

Jump to: navigation, search

Table of Contents >> IPv6 Programmer's Reference


#include <trsocket.h>


int tf6DelDefaultGateway (
ttUserInterface interfaceHandle,
const struct sockaddr_storage TM_FAR * gwyIpAddrPtr
);


Function Description

This function is used to delete a previously created IPv6 default gateway.



Parameters

  • interfaceHandle
    This is the interface handle which identifies the network where the IPv6 default router resides.
  • gwyIpAddrPtr
    This is the default gateway's IPv6 address. This memory is used to hold this information and must be allocated by the caller (i.e. reside in the caller's address space).
  • flags
    This parameter is not currently used.


Returns

  • TM_ENOERROR
    Success.
  • TM_EINVAL
    This indicates failure. The kernel found invalid arguments in the call.
  • TM_EAFNOSUPPORT
    This indicates failure due to malformed content within gwyIpAddrPtr. This can happen when the address is not an IPv6-formatted address (gwIpAddrPtr->addrFamily != AF_INET6 for example) or if the IPv6 address is an IPv4 mapped address.
  • TM_ENOENT
    This indicates failure when the specified gateway is not configured.


Table of Contents >> IPv6 Programmer's Reference