Freigeben über


GetUnicastIpAddressEntry-Funktion

Die GetUnicastIpAddressEntry-Funktion ruft Informationen für einen vorhandenen Unicast-IP-Adresseintrag auf einem lokalen Computer ab.

Syntax

NETIOAPI_API GetUnicastIpAddressEntry(
  _Inout_ PMIB_UNICASTIPADDRESS_ROW Row
);

Parameter

  • Zeile [ein, ausgehend]
    Ein Zeiger auf einen MIB_UNICASTIPADDRESS_ROW-Struktureintrag für einen Unicast-IP-Adresseintrag. Bei erfolgreicher Rückgabe wird diese Struktur mit den Eigenschaften für eine vorhandene Unicast-IP-Adresse aktualisiert.

Rückgabewert

GetUnicastIpAddressEntry gibt STATUS_SUCCESS zurück, wenn die Funktion erfolgreich ist.

Wenn die Funktion fehlschlägt, gibt GetUnicastIpAddressEntry einen der folgenden Fehlercodes zurück:

Rückgabecode Beschreibung
STATUS_INVALID_PARAMETER

Es wurde ein ungültiger Parameter an die Funktion übergeben. Dieser Fehler wird zurückgegeben, wenn ein NULL-Zeiger im Row-Parameter übergeben wird, der Address-Member der MIB_UNICASTIPADDRESS_ROW-Struktur , auf die der Row-Parameter verweist, nicht auf eine gültige Unicast-IPv4- oder IPv6-Adresse festgelegt wurde oder interfaceLuid - und InterfaceIndex-Member der MIB_UNICASTIPADDRESS_ROW-Struktur nicht angegeben wurden.

STATUS_NOT_FOUND

Die angegebene Schnittstelle konnte nicht gefunden werden. Dieser Fehler wird zurückgegeben, wenn die Funktion die Netzwerkschnittstelle nicht finden kann, die vom InterfaceLuid - oder InterfaceIndex-Member der MIB_UNICASTIPADDRESS_ROW-Struktur angegeben wird, auf die der Row-Parameter verweist.

STATUS_NOT_SUPPORTED

Die Anforderung wird nicht unterstützt. Dieser Fehler wird zurückgegeben, wenn sich kein IPv4-Stapel auf dem lokalen Computer befindet und eine IPv4-Adresse im Address-Member der MIB_UNICASTIPADDRESS_ROW-Struktur angegeben wurde, auf die der Row-Parameter verweist, oder wenn sich kein IPv6-Stapel auf dem lokalen Computer befindet und im Address-Member eine IPv6-Adresse angegeben wurde.

Andere

Verwenden Sie die FormatMessage-Funktion , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen.

Bemerkungen

Die GetUnicastIpAddressEntry-Funktion wird in der Regel verwendet, um einen vorhandenen MIB_UNICASTIPADDRESS_ROW Struktureintrag abzurufen, der geändert werden soll. Ein Treiber kann dann die Member im MIB_UNICASTIPADDRESS_ROW Eintrag ändern, den er ändern möchte, und dann die SetUnicastIpAddressEntry-Funktion aufrufen.

Bei der Eingabe muss der Treiber die folgenden Member der MIB_UNICASTIPADDRESS_ROW Struktur initialisieren, auf die der Row-Parameter verweist.

  • Adresse
    Legen Sie auf eine gültige Unicast-IPv4- oder IPv6-Adresse und -Familie fest.

  • InterfaceLuid oder InterfaceIndex
    Diese Member werden in der zuvor aufgeführten Reihenfolge verwendet. Wenn Also InterfaceLuid angegeben ist, wird dieser Member verwendet, um die Schnittstelle zu bestimmen. Wenn kein Wert für das InterfaceLuid-Element festgelegt wurde (der Wert dieses Members wurde auf 0 festgelegt), wird als Nächstes das InterfaceIndex-Element verwendet, um die Schnittstelle zu bestimmen.

Wenn der Aufruf erfolgreich ist, ruft GetUnicastIpAddressEntry bei der Ausgabe die anderen Eigenschaften für die Unicast-IP-Adresse ab und füllt die MIB_UNICASTIPADDRESS_ROW Struktur aus, auf die der Row-Parameter verweist.

Ihr Treiber kann die GetUnicastIpAddressTable-Funktion aufrufen, um die Unicast-IP-Adresseinträge auf einem lokalen Computer aufzulisten.

Anforderungen

Zielplattform

Universell

Version

Verfügbar in Windows Vista und höheren Versionen der Windows-Betriebssysteme.

Header

Netioapi.h (netioapi.h einschließen)

Bibliothek

Netio.lib

IRQL

< DISPATCH_LEVEL

Weitere Informationen

CreateUnicastIpAddressEntry

DeleteUnicastIpAddressEntry

GetUnicastIpAddressTable

InitializeUnicastIpAddressEntry

MIB_UNICASTIPADDRESS_ROW

MIB_UNICASTIPADDRESS_TABLE

NotifyUnicastIpAddressChange

SetUnicastIpAddressEntry