GetUnicastIpAddressEntry 函式
GetUnicastIpAddressEntry 函式會擷取本機電腦上現有單播 IP 地址項目的資訊。
語法
NETIOAPI_API GetUnicastIpAddressEntry(
_Inout_ PMIB_UNICASTIPADDRESS_ROW Row
);
參數
-
列 [in, out]
單播IP位址專案的 MIB_UNICASTIPADDRESS_ROW 結構專案的指標。 成功傳回時,會使用現有單播IP位址的屬性來更新此結構。
傳回值
如果函式成功,GetUnicastIpAddressEntry 會傳回 STATUS_SUCCESS。
如果函式失敗,GetUnicastIpAddressEntry 會傳回下列其中一個錯誤碼:
傳回碼 | 描述 |
---|---|
STATUS_INVALID_PARAMETER | 無效的參數已傳遞至函式。 如果在 Row 參數中傳遞 NULL 指標,則會傳回此錯誤。 AddressMIB_UNICASTIPADDRESS_ROW 結構的成員,Row 參數所指向的成員未設定為有效的單播 IPv4 或 IPv6 位址,或未指定 InterfaceLuid 和 InterfaceIndexMIB_UNICASTIPADDRESS_ROW 成員。 |
STATUS_NOT_FOUND | 找不到指定的介面。 如果函式找不到由 InterfaceLuid 或 InterfaceIndex 所指定的網路介面,則會傳回此錯誤,Row 參數所指向之 MIB_UNICASTIPADDRESS_ROW 結構 成員。 |
STATUS_NOT_SUPPORTED | 不支援要求。 如果本機計算機上沒有IPv4堆棧,且在 MIB_UNICASTIPADDRESS_ROW 結構 位址 成員中指定了 IPv4 位址,則傳回此錯誤 列 參數所指向,或如果本機計算機上沒有 IPv6 堆棧,且已在 位址 成員中指定 IPv6 位址。 |
其他 | 使用 FormatMessage 函式取得傳回錯誤的訊息字串。 |
言論
GetUnicastIpAddressEntry 函式通常用於擷取要修改的現有 MIB_UNICASTIPADDRESS_ROW 結構專案。 然後,驅動程式可以變更其想要修改之 MIB_UNICASTIPADDRESS_ROW 專案中的成員,然後呼叫 SetUnicastIpAddressEntry 函式。
在輸入時,驅動程式必須初始化 Row 參數指向的下列 MIB_UNICASTIPADDRESS_ROW 結構成員。
位址
設定為有效的單播 IPv4 或 IPv6 位址和系列。InterfaceLuid 或 InterfaceIndex
這些成員會依照稍早所列的順序使用。 因此,如果指定 InterfaceLuid,則會使用此成員來判斷介面。 如果未為 InterfaceLuid 成員設定任何值(此成員的值設定為零),則 InterfaceIndex 成員會接著用來判斷介面。
在輸出中,當呼叫成功時,GetUnicastIpAddressEntry 擷取單播 IP 位址的其他屬性,並填入 Row 參數指向的 MIB_UNICASTIPADDRESS_ROW 結構。
您的驅動程式可以呼叫 getUnicastIpAddressTable 函式來列舉本機電腦上的單播IP位址專案。
要求
目標平臺 |
通用 |
版本 |
可在 Windows Vista 和更新版本的 Windows作系統中使用。 |
頁眉 |
Netioapi.h (包括 Netioapi.h) |
圖書館 |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |