getAnycastIpAddressEntry 函式 (netioapi.h)

發行項
03/05/2024

GetAnycastIpAddressEntry 函式會擷取本機計算機上現有任何傳播IP位址項目的資訊。

語法

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetAnycastIpAddressEntry(
  [in, out] PMIB_ANYCASTIPADDRESS_ROW Row
);

參數

[in, out] Row

任何傳播IP位址專案的 MIB_ANYCASTIPADDRESS_ROW 結構專案的指標。成功傳回時，此結構將會更新為現有任何傳播IP位址的屬性。

傳回值

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

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

傳回碼	Description
ERROR_FILE_NOT_FOUND	系統找不到指定的檔案。如果 Row 參數所指向MIB_ANYCASTIPADDRESS_ROW的 InterfaceLuid 或 InterfaceIndex 成員所指定的網路介面 LUID 或介面索引不是本機電腦上的值，就會傳回此錯誤。
ERROR_INVALID_PARAMETER	參數不正確。如果在 Row 參數中傳遞 NULL 指標、Row 參數所指向之MIB_ANYCASTIPADDRESS_ROW的 Address 成員未設定為有效的任何傳播 IPv4 或 IPv6 位址，或是未指定 Row 參數所指向之MIB_ANYCASTIPADDRESS_ROW的 InterfaceLuid 或InterfaceIndex 成員，就會傳回此錯誤。
ERROR_NOT_FOUND	Element not found. 如果 Row 參數所指向之 MIB_ANYCASTIPADDRESS_ROW 結構的 InterfaceLuid 或 InterfaceIndex 成員所指定的網路介面不符合 MIB_ANYCASTIPADDRESS_ROW 結構之 Address 成員中指定的 IP 位址和位址系列，就會傳回此錯誤。
ERROR_NOT_SUPPORTED	不支援此要求。如果本機計算機上沒有IPv4堆棧，而且在Row參數所指向之 MIB_UNICASTIPADDRESS_ROW 結構的Address成員中指定了IPv4位址，就會傳回此錯誤。如果本機計算機上沒有IPv6堆疊且在 Address 成員中指定IPv6位址，則會傳回此錯誤。
其他	使用 FormatMessage 取得傳回錯誤的訊息字串。

備註

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

GetAnycastIpAddressEntry 函式可用來擷取現有的MIB_ANYCASTIPADDRESS_ROW結構專案。

在輸入時，Row 參數所指向之MIB_ANYCASTIPADDRESS_ROW結構中的 Address 成員必須初始化為有效的任何傳播 IPv4 或 IPv6 位址和系列。此外，至少必須初始化指向 Row 參數之MIB_ANYCASTIPADDRESS_ROW結構中的下列其中一個成員：InterfaceLuid 或 InterfaceIndex。

欄位會依照上面所列的順序使用。因此，如果指定 InterfaceLuid ，則會使用此成員來判斷介面。如果未為 InterfaceLuid 成員設定任何值， (這個成員的值會設定為零) ，則接著會使用 InterfaceIndex 成員來判斷介面。

在呼叫成功時輸出時，GetAnycastIpAddressEntry 會擷取任何廣播IP位址的其他屬性，並填入Row參數所指向的MIB_ANYCASTIPADDRESS_ROW結構。

您可以呼叫 GetAnycastIpAddressTable 函式來列舉本機電腦上的任何傳送 IP 位址專案。

規格需求

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