Legacy Document

Important: The information in this document is obsolete and should not be used for new development.

Inside Macintosh: Networking With Open Transport / Part 2 - Open Transport Reference

Chapter 29 - TCP/IP Services Reference / Functions

OTInetGetSecondaryAddress
Returns the active secondary IP addresses.

C INTERFACE
void OTInetGetSecondaryAddress (InetHost* addr,
                     UInt32* count, 
                     SInt32 index);
C++ INTERFACE
None. C++ clients use the C interface to this function.

PARAMETERS

addr
A pointer to a buffer into which the secondary IP addresses are placed when the function returns.
count
The number of secondary IP address that must fit in the buffer referenced by the address parameter. You obtain this number by examining the fIPSecondaryCount field of the InetInterfaceInfo structure.
index
Specifies the IP interface for which to obtain secondary addresses. For the primary IP interface,the index is 0.

DISCUSSION
This function copies the supported secondary addresses associated with an IP interface. The count parameter specifies how many secondary address to return in the buffer referenced by the addr parameter. This buffer must be of the size count * sizeof(InetAddr) to return all of the available addresses. Use the value stored in the fIPSecondaryCount field of the InetInterfaceInfo structure for the count parameter. The OTInetGetSecondaryAddress function modifies the count value to indicate that the number of secondary addresses actually returned is less than the specified number of secondary addresses.