GetAnycastIpAddressEntry-Funktion (netioapi.h)

Artikel
08/25/2023

Die GetAnycastIpAddressEntry-Funktion ruft Informationen für einen vorhandenen Anycast-IP-Adresseintrag auf dem lokalen Computer ab.

Syntax

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetAnycastIpAddressEntry(
  [in, out] PMIB_ANYCASTIPADDRESS_ROW Row
);

Parameter

[in, out] Row

Ein Zeiger auf einen MIB_ANYCASTIPADDRESS_ROW-Struktureintrag für einen Anycast-IP-Adresseintrag. Bei erfolgreicher Rückgabe wird diese Struktur mit den Eigenschaften für eine vorhandene anycast-IP-Adresse aktualisiert.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert NO_ERROR.

Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes.

Rückgabecode	Beschreibung
ERROR_FILE_NOT_FOUND	Die angegebene Datei wurde nicht gefunden. Dieser Fehler wird zurückgegeben, wenn die LUID der Netzwerkschnittstelle oder der Schnittstellenindex, der vom InterfaceLuid - oder InterfaceIndex-Member des MIB_ANYCASTIPADDRESS_ROW angegeben wird, auf den der Row-Parameter verweist, kein Wert auf dem lokalen Computer ist.
ERROR_INVALID_PARAMETER	Ein Parameter ist falsch. Dieser Fehler wird zurückgegeben, wenn ein NULL-Zeiger im Row-Parameter übergeben wird, der Address-Member des MIB_ANYCASTIPADDRESS_ROW , auf den der Row-Parameter verweist, nicht auf eine gültige Anycast-IPv4- oder IPv6-Adresse festgelegt ist, oder die Member InterfaceLuid oder InterfaceIndex der MIB_ANYCASTIPADDRESS_ROW , auf die der Row-Parameter verweist, nicht angegeben wurden.
ERROR_NOT_FOUND	Element wurde nicht gefunden. Dieser Fehler wird zurückgegeben, wenn die Netzwerkschnittstelle, die vom InterfaceLuid - oder InterfaceIndex-Member der MIB_ANYCASTIPADDRESS_ROW-Struktur angegeben wird, auf die der Row-Parameter verweist, nicht mit der IP-Adresse und Adressfamilie übereinstimmt, die im Address-Member in der MIB_ANYCASTIPADDRESS_ROW-Struktur angegeben sind.
ERROR_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 ist, auf die der Row-Parameter verweist. Dieser Fehler wird zurückgegeben, wenn sich kein IPv6-Stapel auf dem lokalen Computer befindet und im Adresselement eine IPv6-Adresse angegeben ist.
Andere	Verwenden Sie FormatMessage , um die Meldungszeichenfolge für den zurückgegebenen Fehler abzurufen.

Hinweise

Die GetAnycastIpAddressEntry-Funktion ist unter Windows Vista und höher definiert.

Die GetAnycastIpAddressEntry-Funktion wird verwendet, um einen vorhandenen MIB_ANYCASTIPADDRESS_ROW-Struktureintrag abzurufen.

Bei der Eingabe muss das Adresselement in der MIB_ANYCASTIPADDRESS_ROW Struktur, auf die der Row-Parameter verweist, mit einer gültigen Anycast-IPv4- oder IPv6-Adresse und -Familie initialisiert werden. Darüber hinaus muss mindestens einer der folgenden Member in der MIB_ANYCASTIPADDRESS_ROW Struktur, die auf den Row-Parameter verweist, initialisiert werden: InterfaceLuid oder InterfaceIndex.

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

Bei der Ausgabe, wenn der Aufruf erfolgreich ist, ruft GetAnycastIpAddressEntry die anderen Eigenschaften für die anycast-IP-Adresse ab und füllt die MIB_ANYCASTIPADDRESS_ROW Struktur aus, auf die der Row-Parameter verweist.

Die GetAnycastIpAddressTable-Funktion kann aufgerufen werden, um die Anycast-IP-Adresseinträge auf einem lokalen Computer aufzulisten.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	netioapi.h (include Iphlpapi.h)
Bibliothek	Iphlpapi.lib
DLL	Iphlpapi.dll