共用方式為


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指標、Row參數指向的 MIB_UNICASTIPADDRESS_ROW結構的Address成員未設定為有效的單播 IPv4 或 IPv6 位址,或是未指定MIB_UNICASTIPADDRESS_ROW結構的InterfaceLuidInterfaceIndex成員,就會傳回此錯誤。

STATUS_NOT_FOUND

找不到指定的介面。 如果函式找不到Row參數指向之 MIB_UNICASTIPADDRESS_ROW結構的InterfaceLuidInterfaceIndex成員所指定的網路介面,就會傳回此錯誤。

STATUS_NOT_SUPPORTED

不支援此要求。 如果本機電腦上沒有 IPv4 堆疊,而且在Row參數所指向之 MIB_UNICASTIPADDRESS_ROW結構的Address成員中指定了 IPv4 位址,或如果本機電腦上沒有 IPv6 堆疊,且位址成員中指定了 IPv6 位址,則會傳回此錯誤。

其他

使用 FormatMessage 函式來取得傳回錯誤的訊息字串。

備註

GetUnicastIpAddressEntry函式通常用於擷取要修改的現有MIB_UNICASTIPADDRESS_ROW結構專案。 驅動程式接著可以變更其想要修改 之MIB_UNICASTIPADDRESS_ROW 專案中的成員,然後呼叫 SetUnicastIpAddressEntry 函式。

在輸入時,驅動程式必須初始化Row參數指向的下列MIB_UNICASTIPADDRESS_ROW結構成員。

  • 位址
    設定為有效的單播 IPv4 或 IPv6 位址和系列。

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

在輸出中,當呼叫成功時,GetUnicastIpAddressEntry會擷取單播 IP 位址的其他屬性,並填入Row參數所指向的MIB_UNICASTIPADDRESS_ROW結構。

驅動程式可以呼叫 GetUnicastIpAddressTable 函式,以列舉本機電腦上的單播 IP 位址專案。

規格需求

目標平台

普遍

版本

可在 Windows Vista 和更新版本的 Windows 作業系統中使用。

標頭

Netioapi.h (包含 Netioapi.h)

程式庫

Netio.lib

IRQL

< DISPATCH_LEVEL

另請參閱

CreateUnicastIpAddressEntry

DeleteUnicastIpAddressEntry

GetUnicastIpAddressTable

InitializeUnicastIpAddressEntry

MIB_UNICASTIPADDRESS_ROW

MIB_UNICASTIPADDRESS_TABLE

NotifyUnicastIpAddressChange

SetUnicastIpAddressEntry