GetMulticastIpAddressEntry 函式 (netioapi.h)
GetMulticastIpAddressEntry 函式會擷取本機計算機上現有多播IP位址項目的資訊。
語法
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetMulticastIpAddressEntry(
[in, out] PMIB_MULTICASTIPADDRESS_ROW Row
);
參數
[in, out] Row
多播IP位址專案的 MIB_MULTICASTIPADDRESS_ROW 結構專案的指標。 成功傳回時,將會使用現有多播IP位址的屬性來更新此結構。
傳回值
如果函式成功,傳回值會NO_ERROR。
如果函式失敗,傳回值就是下列其中一個錯誤碼。
傳回碼 | Description |
---|---|
|
系統找不到指定的檔案。 如果 Row 參數所指向 MIB_MULTICASTIPADDRESS_ROW的InterfaceLuid 或 InterfaceIndex 成員所指定的網路介面 LUID 或介面索引不是本機電腦上的值,就會傳回這個錯誤。 |
|
參數不正確。 如果在 Row 參數中傳遞 NULL 指標、Row 參數所指向之MIB_MULTICASTIPADDRESS_ROW的 Address 成員未設定為有效的多播 IPv4 或 IPv6 位址,或是未指定 Row 參數所指向之MIB_MULTICASTIPADDRESS_ROW的 InterfaceLuid 或 InterfaceIndex 成員,就會傳回此錯誤。 |
|
Element not found. 如果 Row 參數所指向之 MIB_MULTICASTIPADDRESS_ROW 結構的 InterfaceLuid 或 InterfaceIndex 成員所指定的網路介面不符合 MIB_MULTICASTIPADDRESS_ROW 結構中地址成員中指定的 IP 位址和位址系列,就會傳回此錯誤。 |
|
不支援此要求。 如果本機計算機上沒有IPv4堆棧,而且在Row參數所指向的Address成員MIB_MULTICASTIPADDRESS_ROW指定IPv4位址,就會傳回此錯誤。 如果本機計算機上沒有IPv6堆棧,並在 Address 成員中指定IPv6位址,也會傳回此錯誤。 |
|
使用 FormatMessage 取得傳回錯誤的訊息字串。 |
備註
GetMulticastIpAddressEntry 函式是在 Windows Vista 和更新版本上定義。
GetMulticastIpAddressEntry 函式可用來擷取現有的MIB_MULTICASTIPADDRESS_ROW結構專案。
在輸入時,Row 參數所指向之MIB_MULTICASTIPADDRESS_ROW結構中的 Address 成員必須初始化為有效的多播 IPv4 或 IPv6 位址和系列。 此外,必須初始化指向 Row 參數之MIB_MULTICASTIPADDRESS_ROW結構中至少一個下列成員:InterfaceLuid 或 InterfaceIndex。
欄位會依照上面所列的順序使用。 因此,如果指定 InterfaceLuid ,則會使用此成員來判斷介面。 如果 InterfaceLuid 成員沒有設定任何值, (這個成員的值會設定為零) ,則 Next 會使用 InterfaceIndex 成員來判斷介面。
呼叫成功時,GetMulticastIpAddressEntry 會在輸出中擷取多播IP位址的其他屬性,並填入Row參數所指向的MIB_MULTICASTIPADDRESS_ROW結構。
您可以呼叫 GetMulticastIpAddressTable 函式來列舉本機電腦上的多播 IP 位址專案。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2008 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | netioapi.h (包括 Iphlpapi.h) |
程式庫 | Iphlpapi.lib |
Dll | Iphlpapi.dll |