Dela via


Funktionen GetUnicastIpAddressEntry

Funktionen GetUnicastIpAddressEntry hämtar information om en befintlig unicast-IP-adresspost på en lokal dator.

Syntax

NETIOAPI_API GetUnicastIpAddressEntry(
  _Inout_ PMIB_UNICASTIPADDRESS_ROW Row
);

Parametrar

  • Rad [in, ut]
    En pekare till en MIB_UNICASTIPADDRESS_ROW strukturpost för en unicast-IP-adresspost. Vid lyckad retur uppdateras den här strukturen med egenskaperna för en befintlig unicast-IP-adress.

Returvärde

GetUnicastIpAddressEntry returnerar STATUS_SUCCESS om funktionen lyckas.

Om funktionen misslyckas returnerar GetUnicastIpAddressEntry någon av följande felkoder:

Returnera kod Beskrivning
STATUS_INVALID_PARAMETER

En ogiltig parameter skickades till funktionen. Det här felet returneras om en NULL- pekare skickas i parametern Rad. -adressen medlem i den MIB_UNICASTIPADDRESS_ROW struktur som parametern Rad pekar på inte var inställd på en giltig unicast IPv4- eller IPv6-adress, eller både InterfaceLuid och InterfaceIndex medlemmar i MIB_UNICASTIPADDRESS_ROW-strukturen var ospecificerade.

STATUS_NOT_FOUND

Det gick inte att hitta det angivna gränssnittet. Det här felet returneras om funktionen inte kan hitta nätverksgränssnittet som anges av InterfaceLuid eller InterfaceIndex medlem i den MIB_UNICASTIPADDRESS_ROW struktur som rad parameter pekar på.

STATUS_NOT_SUPPORTED

Begäran stöds inte. Det här felet returneras om ingen IPv4-stack finns på den lokala datorn och en IPv4-adress angavs i adress medlem i MIB_UNICASTIPADDRESS_ROW struktur som rad parameter pekar på, eller om ingen IPv6-stack finns på den lokala datorn och en IPv6-adress angavs i adress medlem.

Andra

Använd funktionen FormatMessage för att hämta meddelandesträngen för det returnerade felet.

Anmärkningar

Funktionen GetUnicastIpAddressEntry används vanligtvis för att hämta en befintlig MIB_UNICASTIPADDRESS_ROW strukturpost som ska ändras. En drivrutin kan sedan ändra medlemmarna i posten MIB_UNICASTIPADDRESS_ROW som den vill ändra och sedan anropa funktionen SetUnicastIpAddressEntry.

Vid indata måste drivrutinen initiera följande medlemmar i den MIB_UNICASTIPADDRESS_ROW struktur som rad parametern pekar på.

  • adress
    Ange till en giltig unicast IPv4- eller IPv6-adress och -familj.

  • InterfaceLuid eller InterfaceIndex
    Dessa medlemmar används i den ordning som anges tidigare. Så om InterfaceLuid anges används den här medlemmen för att fastställa gränssnittet. Om inget värde har angetts för InterfaceLuid medlem (värdet för den här medlemmen har angetts till noll) används InterfaceIndex medlem för att fastställa gränssnittet.

När anropet lyckas hämtar GetUnicastIpAddressEntry de andra egenskaperna för unicast-IP-adressen och fyller i den MIB_UNICASTIPADDRESS_ROW struktur som rad parametern pekar på.

Drivrutinen kan anropa funktionen GetUnicastIpAddressTable för att räkna upp unicast-IP-adressposterna på en lokal dator.

Krav

Målplattform

Universell

Version

Finns i Windows Vista och senare versioner av Windows-operativsystemen.

Rubrik

Netioapi.h (inkludera Netioapi.h)

Bibliotek

Netio.lib

IRQL

< DISPATCH_LEVEL

Se även

CreateUnicastIpAddressEntry

DeleteUnicastIpAddressEntry

GetUnicastIpAddressTable

InitializeUnicastIpAddressEntry

MIB_UNICASTIPADDRESS_ROW

MIB_UNICASTIPADDRESS_TABLE

NotifyUnicastIpAddressChange

SetUnicastIpAddressEntry