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 [in, out]
Ein Zeiger auf einen MIB_UNICASTIPADDRESS_ROW Struktureintrag für einen Unicast-IP-Adresseintrag. Bei erfolgreicher Rückgabe wird diese Struktur mit den Eigenschaften einer vorhandenen 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 | An die Funktion wurde ein ungültiger Parameter übergeben. Dieser Fehler wird zurückgegeben, wenn ein NULL- Zeiger im parameter Row übergeben wird. das Address Member der MIB_UNICASTIPADDRESS_ROW-Struktur, auf das der parameter Row verweist, nicht auf eine gültige Unicast-IPv4- oder IPv6-Adresse festgelegt wurde, oder InterfaceLuid und InterfaceIndex Member der MIB_UNICASTIPADDRESS_ROW Struktur wurden nicht angegeben. |
| STATUS_NOT_FOUND | Die angegebene Schnittstelle konnte nicht gefunden werden. Dieser Fehler wird zurückgegeben, wenn die Funktion die Netzwerkschnittstelle nicht finden kann, die durch das InterfaceLuid- oder InterfaceIndex-Element 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 eine IPv6-Adresse im Address Member 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 Elemente 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 Elemente der MIB_UNICASTIPADDRESS_ROW Struktur initialisieren, auf die der Row-Parameter verweist.
Adresse
Festlegen auf eine gültige Unicast-IPv4- oder IPv6-Adresse und -Familie.InterfaceLuid oder InterfaceIndex-
Diese Member werden in der Reihenfolge verwendet, die zuvor aufgeführt ist. Wenn also InterfaceLuid- angegeben wird, wird dieses Element verwendet, um die Schnittstelle zu bestimmen. Wenn kein Wert für das InterfaceLuid Member festgelegt wurde (der Wert dieses Elements wurde auf Null festgelegt), wird das InterfaceIndex Member als Nächstes verwendet, um die Schnittstelle zu bestimmen.
Wenn der Aufruf erfolgreich ist, ruft GetUnicastIpAddressEntry 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 auflisten zu können.
Anforderungen
Zielplattform |
universelle |
Version |
Verfügbar in Windows Vista und höheren Versionen der Windows-Betriebssysteme. |
Kopfball |
Netioapi.h (include Netioapi.h) |
Bibliothek |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |