tfBootpUserGetBootEntry

Jump to: navigation, search

Table of Contents >> Optional Protocols >> BOOTP User Controlled Configuration


#include <trsocket.h>


ttUserBtEntryPtr tfBootpUserGetBootEntry (
ttUserInterface interfaceHandle,
int index
);


Function Description

This function acquires a pointer to a BOOTP user BOOT entry.


Parameters

  • interfaceHandle
    This is the Ethernet interface handle.
  • index
    This is the userIndex from tfBootpUserStart() which must be between 0 and tvMaxUserDhcpEntries – 1.


Returns

  • NULL
    Failure. No BOOTP address is bound.
  • (Other)
    Success. The userBtEntryPtr that is returned contains the following:
  • btuYiaddr
This is the allocated IP address.
  • btuDefRouter
This is the default router entry.
  • btuDns1ServerIpAddress
This is the Primary Domain Name Server.
  • btuDns2ServerIpAddress
This is the Secondary Domain Name Server.


Usage

Call this function only after a successful call to tfBootpUserStart().


Table of Contents >> Optional Protocols >> BOOTP User Controlled Configuration