共用方式為

GetUnicastIpAddressTable 函式 (netioapi.h)

  • 發行項

GetUnicastIpAddressTable函式會擷取本機電腦上的單播 IP 位址資料表。

語法

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetUnicastIpAddressTable(
  [in]  ADDRESS_FAMILY              Family,
  [out] PMIB_UNICASTIPADDRESS_TABLE *Table
);

參數

[in] Family

要擷取的位址系列。

位址系列的可能值列在 Winsock2.h 標頭檔中。 請注意，AF_位址系列和PF_通訊協定系列常數的值 (相同，例如， AF_INET 和 PF_INET) ，因此可以使用任一個常數。

在針對 Windows Vista 和更新版本發行的 Windows SDK 上，標頭檔的組織已變更，而且此成員的可能值定義在 Ws2def.h 標頭檔中。 請注意， Ws2def.h 標頭檔會自動包含在 Winsock2.h中，不應直接使用。

目前支援的值AF_INET、AF_INET6和AF_UNSPEC。

值 意義
AF_UNSPEC
0
 未指定位址系列。 指定此參數時，此函式會傳回包含 IPv4 和 IPv6 專案的單播 IP 位址表。
AF_INET
2
 網際網路通訊協定第 4 版 (IPv4) 位址系列。 指定此參數時，此函式會傳回只包含 IPv4 專案的單播 IP 位址表。
AF_INET6
23
 網際網路通訊協定第 6 版 (IPv6) 位址系列。 指定此參數時，此函式會傳回只包含 IPv6 專案的單播 IP 位址表。

[out] Table

MIB_UNICASTIPADDRESS_TABLE結構的指標，其中包含本機電腦上的單播 IP 位址專案資料表。

傳回值

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

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

傳回碼 描述
ERROR_INVALID_PARAMETER
 不正確參數已傳遞至 函式。 如果在Table參數中傳遞Null指標，或Family參數未指定為AF_INET、AF_INET6或AF_UNSPEC，則會傳回此錯誤。
ERROR_NOT_ENOUGH_MEMORY
 記憶體資源不足，無法完成作業。
ERROR_NOT_FOUND
 Element not found. 如果找不到 Family 參數中指定的單播 IP 位址專案，就會傳回此錯誤。
ERROR_NOT_SUPPORTED
 不支援此要求。 如果本機電腦上沒有 IPv4 堆疊，而且已在Family參數中指定AF_INET，就會傳回此錯誤。 如果本機電腦上沒有 IPv6 堆疊，而且已在Family參數中指定AF_INET6，也會傳回此錯誤。 這個錯誤也會在不支援此函式的 Windows 版本上傳回。
其他
 使用 FormatMessage 取得傳回錯誤的訊息字串。

備註

GetUnicastIpAddressTable函式是在 Windows Vista 和更新版本上定義。

此
GetUnicastIpAddressTable 函式會列舉本機系統上的單播 IP 位址，並在 MIB_UNICASTIPADDRESS_TABLE 結構中傳回這項資訊。

單播 IP 位址專案會在Table參數所指向緩衝區的MIB_UNICASTIPADDRESS_TABLE結構中傳回。 MIB_UNICASTIPADDRESS_TABLE結構包含單播 IP 位址專案計數，以及每個單播 IP 位址專案的MIB_UNICASTIPADDRESS_ROW結構陣列。 不再需要這些傳回的結構時，呼叫 FreeMibTable以釋放記憶體。

Family參數必須初始化為AF_INET、AF_INET6或AF_UNSPEC。

請注意，Table參數所指向的傳回MIB_UNICASTIPADDRESS_TABLE結構可能包含NumEntries成員與MIB_UNICASTIPADDRESS_TABLE結構之Table成員中的第一個MIB_UNICASTIPADDRESS_ROW陣列專案之間的對齊填補。 對齊方式的填補也可能存在於 MIB_UNICASTIPADDRESS_ROW 陣列專案之間。 任何對 MIB_UNICASTIPADDRESS_ROW 陣列專案的存取都應該假設可能存在填補。

範例

下列範例會擷取單播 IP 位址表，並列印每個擷取 MIB_UNICASTIPADDRESS_ROW 結構中的一些值。


#ifndef UNICODE
#define UNICODE
#endif

#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif

#include <Windows.h.>
#include <winsock2.h>
#include <ws2tcpip.h>
#include <ws2ipdef.h>
#include <iphlpapi.h>
#include <stdio.h>
#include <stdlib.h>

// Need to link with Iphlpapi.lib and Ws2_32.lib
#pragma comment (lib, "iphlpapi.lib")
#pragma comment (lib, "Ws2_32.lib")

int __cdecl wmain()
{

    // Declare and initialize variables

    unsigned int i;

    DWORD Result = 0;

    WCHAR Ipv4String[16] = { 0 };
    WCHAR Ipv6String[46] = { 0 };

    PMIB_UNICASTIPADDRESS_TABLE pipTable = NULL;

    Result = GetUnicastIpAddressTable(AF_UNSPEC, &pipTable);
    if (Result != NO_ERROR) {
        wprintf(L"GetUnicastIpAddressTable returned error: %ld\n", Result);
        exit(1);
    }
    // Print some variables from the rows in the table
    wprintf(L"Number of table entries: %d\n\n", pipTable->NumEntries);

    for (i = 0; i < pipTable->NumEntries; i++) {
        wprintf(L"AddressFamily[%d]:\t\t ", i);

        switch (pipTable->Table[i].Address.si_family) {
        case AF_INET:
            wprintf(L"IPv4\n");
            if (InetNtopW
                (AF_INET, &pipTable->Table[i].Address.Ipv4.sin_addr, Ipv4String,
                 16) != NULL)
                wprintf(L"IPv4 Address:\t\t\t %ws\n", Ipv4String);
            break;
        case AF_INET6:
            wprintf(L"IPv6\n");
            if (InetNtopW
                (AF_INET6, &pipTable->Table[i].Address.Ipv6.sin6_addr,
                 Ipv6String, 46) != NULL)
                wprintf(L"IPv6 Address:\t\t\t %ws\n", Ipv6String);
            break;
        default:
            wprintf(L"Other: %d\n", pipTable->Table[i].Address.si_family);
            break;
        }

        wprintf(L"Interface LUID NetLuidIndex[%d]:  %lu\n",
               i, pipTable->Table[i].InterfaceLuid.Info.NetLuidIndex);
        wprintf(L"Interface LUID IfType[%d]:\t ", i);
        switch (pipTable->Table[i].InterfaceLuid.Info.IfType) {
        case IF_TYPE_OTHER:
            wprintf(L"Other\n");
            break;
        case IF_TYPE_ETHERNET_CSMACD:
            wprintf(L"Ethernet\n");
            break;
        case IF_TYPE_ISO88025_TOKENRING:
            wprintf(L"Token ring\n");
            break;
        case IF_TYPE_PPP:
            wprintf(L"PPP\n");
            break;
        case IF_TYPE_SOFTWARE_LOOPBACK:
            wprintf(L"Software loopback\n");
            break;
        case IF_TYPE_ATM:
            wprintf(L"ATM\n");
            break;
        case IF_TYPE_IEEE80211:
            wprintf(L"802.11 wireless\n");
            break;
        case IF_TYPE_TUNNEL:
            wprintf(L"Tunnel encapsulation\n");
            break;
        case IF_TYPE_IEEE1394:
            wprintf(L"IEEE 1394 (Firewire)\n");
            break;
        default:
            wprintf(L"Unknown: %d\n",
                   pipTable->Table[i].InterfaceLuid.Info.IfType);
            break;
        }

        wprintf(L"Interface Index[%d]:\t\t %lu\n",
               i, pipTable->Table[i].InterfaceIndex);

        wprintf(L"Prefix Origin[%d]:\t\t ", i);
        switch (pipTable->Table[i].PrefixOrigin) {
        case IpPrefixOriginOther:
            wprintf(L"IpPrefixOriginOther\n");
            break;
        case IpPrefixOriginManual:
            wprintf(L"IpPrefixOriginManual\n");
            break;
        case IpPrefixOriginWellKnown:
            wprintf(L"IpPrefixOriginWellKnown\n");
            break;
        case IpPrefixOriginDhcp:
            wprintf(L"IpPrefixOriginDhcp\n");
            break;
        case IpPrefixOriginRouterAdvertisement:
            wprintf(L"IpPrefixOriginRouterAdvertisement\n");
            break;
        case IpPrefixOriginUnchanged:
            wprintf(L"IpPrefixOriginUnchanged\n");
            break;
        default:
            wprintf(L"Unknown: %d\n", pipTable->Table[i].PrefixOrigin);
            break;
        }

        wprintf(L"Suffix Origin[%d]:\t\t ", i);
        switch (pipTable->Table[i].SuffixOrigin) {
        case IpSuffixOriginOther:
            wprintf(L"IpSuffixOriginOther\n");
            break;
        case IpSuffixOriginManual:
            wprintf(L"IpSuffixOriginManual\n");
            break;
        case IpSuffixOriginWellKnown:
            wprintf(L"IpSuffixOriginWellKnown\n");
            break;
        case IpSuffixOriginDhcp:
            wprintf(L"IpSuffixOriginDhcp\n");
            break;
        case IpSuffixOriginLinkLayerAddress:
            wprintf(L"IpSuffixOriginLinkLayerAddress\n");
            break;
        case IpSuffixOriginRandom:
            wprintf(L"IpSuffixOriginRandom\n");
            break;
        case IpSuffixOriginUnchanged:
            wprintf(L"IpSuffixOriginUnchanged\n");
            break;
        default:
            wprintf(L"Unknown: %d\n", pipTable->Table[i].SuffixOrigin);
            break;
        }

        wprintf(L"Valid Lifetime[%d]:\t\t 0x%x (%u)\n", i,
               pipTable->Table[i].ValidLifetime,
               pipTable->Table[i].ValidLifetime);

        wprintf(L"Preferred Lifetime[%d]:\t\t 0x%x (%u)\n", i,
               pipTable->Table[i].PreferredLifetime,
               pipTable->Table[i].PreferredLifetime);

        wprintf(L"OnLink PrefixLength[%d]:\t\t %lu\n", i,
               pipTable->Table[i].OnLinkPrefixLength);

        wprintf(L"Skip As Source[%d]:\t\t ", i);
        if (pipTable->Table[i].SkipAsSource)
            wprintf(L"Yes\n");
        else
            wprintf(L"No\n");

        wprintf(L"Dad State[%d]:\t\t\t ", i);
        switch (pipTable->Table[i].DadState) {
        case IpDadStateInvalid:
            wprintf(L"IpDadStateInvalid\n");
            break;
        case IpDadStateTentative:
            wprintf(L"IpDadStateTentative\n");
            break;
        case IpDadStateDuplicate:
            wprintf(L"IpDadStateDuplicate\n");
            break;
        case IpDadStateDeprecated:
            wprintf(L"IpDadStateDeprecated\n");
            break;
        case IpDadStatePreferred:
            wprintf(L"IpDadStatePreferred\n");
            break;
        default:
            wprintf(L"Unknown: %d\n", pipTable->Table[i].DadState);
            break;
        }

        wprintf(L"\n");
    }

    if (pipTable != NULL) {
        FreeMibTable(pipTable);
        pipTable = NULL;
    }

    exit(0);
}

需求

   
最低支援的用戶端 Windows Vista [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows Server 2008 [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 netioapi.h (包括 Iphlpapi.h)
程式庫 Iphlpapi.lib
Dll Iphlpapi.dll

另請參閱

CreateUnicastIpAddressEntry

DeleteUnicastIpAddressEntry

FreeMibTable

GetUnicastIpAddressEntry

IP 協助程式函式參考

InitializeUnicastIpAddressEntry

MIB_UNICASTIPADDRESS_ROW

MIB_UNICASTIPADDRESS_TABLE

NotifyStableUnicastIpAddressTable

NotifyUnicastIpAddressChange

SetUnicastIpAddressEntry