tfGetBroadcastAddress

Jump to: navigation, search

Table of Contents >> Programmer's Reference


#include <trsocket.h>


int tfGetBroadcastAddress (
ttUserInterface interfaceHandle,
ttUserIpAddress * ifBroadcastAddressPtr,
unsigned char mHomeIndex
);


Function Description

This function is used to retrieve the broadcast address for 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. The broadcast address is automatically calculated from the IP address and netmask combination.


Parameters

  • interfaceHandle
    The device driver entry that we wish to get the broadcast address on.
  • ifBroadcastAddressPtr
    The pointer to the area that the function will store the broadcast address into.
  • 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