tfGetIpAddress

Jump to: navigation, search

Table of Contents >> Programmer's Reference

Note Note: The content on this page has been deprecated.
For the new content, please see tfNgGetIpAddress().


#include <trsocket.h>


int tfGetIpAddress (
ttUserInterface interfaceId,
ttUserIpAddress * ifIpAddressPtr,
unsigned char mHomeIndex
);


Function Description

This function is used to get the IP address of an interface. The multihome index is used for interfaces that have more than one IP address. If the interface has only one IP address then the multihome index should be set to zero.


Parameters

  • interfaceId
    The device driver entry that we wish to get the IP address on.
  • ifIpAddressPtr
    A pointer to the location where to store the IP address for the interface.
  • mHomeIndex
    An index for multiple IP addresses.


Returns

  • TM_ENOERROR
    Success.
  • TM_EINVAL
    Bad parameter.
  • TM_ENETDOWN
    Interface/multihome index is not configured.


Table of Contents >> Programmer's Reference