GetIpAddrTable 函式 (iphlpapi.h)

發行項
08/24/2023

GetIpAddrTable函式會擷取介面對 IPv4 位址對應資料表。

語法

IPHLPAPI_DLL_LINKAGE DWORD GetIpAddrTable(
  [out]     PMIB_IPADDRTABLE pIpAddrTable,
  [in, out] PULONG           pdwSize,
  [in]      BOOL             bOrder
);

參數

[out] pIpAddrTable

緩衝區的指標，接收介面對 IPv4 位址對應資料表做為 MIB_IPADDRTABLE 結構。

[in, out] pdwSize

在輸入上，指定 pIpAddrTable 參數所指向之緩衝區位元組的大小。

在輸出中，如果緩衝區不夠大，無法保存傳回的對應資料表，則函式會將此參數設定為等於所需的緩衝區大小，以位元組為單位。

[in] bOrder

如果此參數為 TRUE，則傳回的對應資料表會依 IPv4 位址的遞增順序排序。排序是以網路位元組循序執行。例如，10.0.0.255 緊接在 10.0.1.0 之前。

傳回值

如果函式成功，傳回值會NO_ERROR。

如果函式失敗，傳回值就是下列其中一個錯誤碼。

傳回碼	描述
ERROR_INSUFFICIENT_BUFFER	pIpAddrTable參數所指向的緩衝區不夠大。必要的大小會在pdwSize參數所指向的DWORD變數中傳回。
ERROR_INVALID_PARAMETER	pdwSize參數為Null，或者GetIpAddrTable無法寫入pdwSize參數所指向的記憶體。
ERROR_NOT_SUPPORTED	本機系統上使用的作業系統不支援此函式。
其他	使用 FormatMessage 取得傳回錯誤的訊息字串。

備註

GetIpAddrTable函式會擷取本機電腦上的介面對 IPv4 位址對應資料表，並在MIB_IPADDRTABLE結構中傳回此資訊。

GetIpAddrTable函式所傳回的 IPv4 位址會受到本機電腦上的網路介面狀態影響。手動重設網路介面卡 (NIC) ，某些 PnP 事件可能會導致 IP 位址遭到移除或變更。

在 Windows Server 2003 和 Windows XP 上，如果本機電腦上的 TCP/IP 堆疊媒體感應器功能已藉由呼叫DisableMediaSense函式來停用，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 的存取都應該假設可能存在填補。

在 Microsoft Windows 軟體發展工具組 (SDK) 針對 Windows Vista 和更新版本發行，標頭檔的組織已變更，而且MIB_IPADDRROW 定義在 Ipmib.h 標頭檔中，而不是 在 Iprtrmib.h 標頭檔中。請注意， Ipmib.h 標頭檔會自動包含在 Iprtrmib.h 中，該檔案會自動包含在 Iphlpapi.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 專業版 [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	iphlpapi.h
程式庫	Iphlpapi.lib
Dll	Iphlpapi.dll