getIpAddrTable 函数 (iphlpapi.h)
GetIpAddrTable 函数检索接口到 IPv4 地址映射表。
语法
IPHLPAPI_DLL_LINKAGE DWORD GetIpAddrTable(
[out] PMIB_IPADDRTABLE pIpAddrTable,
[in, out] PULONG pdwSize,
[in] BOOL bOrder
);
parameters
[out] pIpAddrTable
指向缓冲区的指针，该缓冲区接收接口到 IPv4 地址映射表作为 MIB_IPADDRTABLE 结构。
[in, out] pdwSize
输入时，指定 pIpAddrTable 参数指向的缓冲区的大小（以字节为单位）。
在输出时，如果缓冲区不够大，无法容纳返回的映射表，则函数会将此参数设置为等于所需的缓冲区大小（以字节为单位）。
[in] bOrder
如果此参数为 TRUE，则返回的映射表将按 IPv4 地址的升序排序。 排序按网络字节顺序执行。 例如，10.0.0.255 紧接在 10.0.1.0 之前。
返回值
如果函数成功，则返回值NO_ERROR。
如果函数失败，则返回值为以下错误代码之一。
| 返回代码 | 说明 |
|---|---|
|
pIpAddrTable 参数指向的缓冲区不够大。 所需大小在 pdwSize 参数指向的 DWORD 变量中返回。 |
|
pdwSize 参数为 NULL，或者 GetIpAddrTable 无法写入 pdwSize 参数指向的内存。 |
|
本地系统上正在使用的操作系统不支持此函数。 |
|
使用 FormatMessage 获取返回错误的消息字符串。 |
注解
GetIpAddrTable 函数在本地计算机上检索接口到 IPv4 地址映射表，并在MIB_IPADDRTABLE结构中返回此信息。
GetIpAddrTable 函数返回的 IPv4 地址受本地计算机上网络接口的状态的影响。 手动重置网络接口卡 (NIC) 和某些 PnP 事件可能会导致 IP 地址被删除或更改。
在 Windows Server 2003 和 Windows XP 上，如果通过调用 DisableMediaSense 函数禁用了本地计算机上 TCP/IP 堆栈的媒体感知功能，则 GetIpAddrTable 函数返回的 IPv4 地址也会受到影响。 禁用媒体感知后， GetIpAddrTable 函数可能会返回与断开连接的接口关联的 IPv4 地址。 断开连接的接口的这些 Ipv4 地址无效。
在 Windows Server 2008 和 Windows Vista 上， GetIpAddrTable 函数返回的 IPv4 地址不受本地计算机上 TCP/IP 堆栈的媒体感知功能的影响。 GetIpAddrTable 函数仅返回有效的 IPv4 地址。
Windows XP 上可用的 GetAdaptersAddresses 函数可用于检索 IPv6 和 IPv4 地址和接口信息。
GetIpAddrTable 函数返回的 MIB_IPADDRTABLE 结构可能包含用于在 dwNumEntries 成员与表成员中的第一个MIB_IPADDRROW数组条目之间进行对齐的填充。 表成员中的MIB_IPADDRROW数组条目之间也可能存在对齐填充。 对 MIB_IPADDRROW 数组条目的任何访问都应假定可能存在填充。
在为 Windows Vista 及更高版本发布的 Microsoft Windows 软件开发工具包 (SDK) 上，头文件的组织已更改， MIB_IPADDRROW 在 Ipmib.h 头文件中定义，而不是在 Iprtrmib.h 头文件中定义。 请注意，Ipmib.h 头文件会自动包含在 Iphlpapi.h 头文件中的 Iprtrmib.h 中。 不应直接使用 Ipmib.h 和 Iprtrmib.h 头文件。
示例
以下示例检索 IP 地址表，然后打印表中 IP 地址条目的一些成员。
#include <winsock2.h>
#include <ws2tcpip.h>
#include <iphlpapi.h>
#include <stdio.h>
#pragma comment(lib, "iphlpapi.lib")
#pragma comment(lib, "ws2_32.lib")
#define MALLOC(x) HeapAlloc(GetProcessHeap(), 0, (x))
#define FREE(x) HeapFree(GetProcessHeap(), 0, (x))
/* Note: could also use malloc() and free() */
int __cdecl main()
{
int i;
/* Variables used by GetIpAddrTable */
PMIB_IPADDRTABLE pIPAddrTable;
DWORD dwSize = 0;
DWORD dwRetVal = 0;
IN_ADDR IPAddr;
/* Variables used to return error message */
LPVOID lpMsgBuf;
// Before calling AddIPAddress we use GetIpAddrTable to get
// an adapter to which we can add the IP.
pIPAddrTable = (MIB_IPADDRTABLE *) MALLOC(sizeof (MIB_IPADDRTABLE));
if (pIPAddrTable) {
// Make an initial call to GetIpAddrTable to get the
// necessary size into the dwSize variable
if (GetIpAddrTable(pIPAddrTable, &dwSize, 0) ==
ERROR_INSUFFICIENT_BUFFER) {
FREE(pIPAddrTable);
pIPAddrTable = (MIB_IPADDRTABLE *) MALLOC(dwSize);
}
if (pIPAddrTable == NULL) {
printf("Memory allocation failed for GetIpAddrTable\n");
exit(1);
}
}
// Make a second call to GetIpAddrTable to get the
// actual data we want
if ( (dwRetVal = GetIpAddrTable( pIPAddrTable, &dwSize, 0 )) != NO_ERROR ) {
printf("GetIpAddrTable failed with error %d\n", dwRetVal);
if (FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, NULL, dwRetVal, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
(LPTSTR) & lpMsgBuf, 0, NULL)) {
printf("\tError: %s", lpMsgBuf);
LocalFree(lpMsgBuf);
}
exit(1);
}
printf("\tNum Entries: %ld\n", pIPAddrTable->dwNumEntries);
for (i=0; i < (int) pIPAddrTable->dwNumEntries; i++) {
printf("\n\tInterface Index[%d]:\t%ld\n", i, pIPAddrTable->table[i].dwIndex);
IPAddr.S_un.S_addr = (u_long) pIPAddrTable->table[i].dwAddr;
printf("\tIP Address[%d]: \t%s\n", i, inet_ntoa(IPAddr) );
IPAddr.S_un.S_addr = (u_long) pIPAddrTable->table[i].dwMask;
printf("\tSubnet Mask[%d]: \t%s\n", i, inet_ntoa(IPAddr) );
IPAddr.S_un.S_addr = (u_long) pIPAddrTable->table[i].dwBCastAddr;
printf("\tBroadCast[%d]: \t%s (%ld%)\n", i, inet_ntoa(IPAddr), pIPAddrTable->table[i].dwBCastAddr);
printf("\tReassembly size[%d]:\t%ld\n", i, pIPAddrTable->table[i].dwReasmSize);
printf("\tType and State[%d]:", i);
if (pIPAddrTable->table[i].wType & MIB_IPADDR_PRIMARY)
printf("\tPrimary IP Address");
if (pIPAddrTable->table[i].wType & MIB_IPADDR_DYNAMIC)
printf("\tDynamic IP Address");
if (pIPAddrTable->table[i].wType & MIB_IPADDR_DISCONNECTED)
printf("\tAddress is on disconnected interface");
if (pIPAddrTable->table[i].wType & MIB_IPADDR_DELETED)
printf("\tAddress is being deleted");
if (pIPAddrTable->table[i].wType & MIB_IPADDR_TRANSIENT)
printf("\tTransient address");
printf("\n");
}
if (pIPAddrTable) {
FREE(pIPAddrTable);
pIPAddrTable = NULL;
}
exit(0);
}
要求
| 最低受支持的客户端 | Windows 2000 Professional [仅限桌面应用] |
| 最低受支持的服务器 | Windows 2000 Server [仅限桌面应用] |
| 目标平台 | Windows |
| 标头 | iphlpapi.h |
| Library | Iphlpapi.lib |
| DLL | Iphlpapi.dll |