tf6InterfaceSetSiteId

Jump to: navigation, search

Table of Contents >> IPv6 Programmer's Reference


#include <trsocket.h>


int tf6InterfaceSetSiteId (
ttUserInterface interfaceHandle,
ttUser32Bit siteId
);


Function Description

This function only supports IPv6. This function is used to change the IPv6 site identifier associated with an interface. The site identifier is used as the scope ID for site-local unicast IPv6 addresses associated with the specified interface. This function may only be called on an interface that is closed, i.e. before tfNgOpenInterface() or tfNgConfigInterface() is called.


Parameters

  • interfaceHandle
    Interface handle of an interface for which we want to set the site identifier.
  • siteId
    The site identifier. Must be non-zero.


Returns

  • 0
    Success.
  • TM_EINVAL
    One of the parameters was invalid.
  • TM_EINVAL
    siteId was 0. siteId must be non-zero.
  • TM_EPERM
    The interface specified by interfaceHandle was open. This function may only be called on an interface that is closed.


Table of Contents >> IPv6 Programmer's Reference