GetAnycastIpAddressTable-Funktion (netioapi.h)

  • Artikel

Die GetAnycastIpAddressTable-Funktion ruft die Anycast-IP-Adresstabelle auf dem lokalen Computer ab.

Syntax

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetAnycastIpAddressTable(
  [in]  ADDRESS_FAMILY              Family,
  [out] PMIB_ANYCASTIPADDRESS_TABLE *Table
);

Parameter

[in] Family

Die abzurufende Adressfamilie.

Mögliche Werte für die Adressfamilie sind in der Winsock2.h-Headerdatei aufgeführt. Beachten Sie, dass die Werte für die AF_ Adressfamilie und PF_ Protokollfamilienkonstanten identisch sind (z. B. AF_INET und PF_INET), sodass beide Konstanten verwendet werden können.

Auf der für Windows Vista und höher veröffentlichten Windows SDK wurde die organization der Headerdateien geändert, und mögliche Werte für dieses Element werden in der Ws2def.h-Headerdatei definiert. Beachten Sie, dass die Ws2def.h-Headerdatei automatisch in Winsock2.h enthalten ist und niemals direkt verwendet werden sollte.

Die derzeit unterstützten Werte sind AF_INET, AF_INET6 und AF_UNSPEC.

Wert Bedeutung
AF_UNSPEC
0
 Die Adressfamilie ist nicht angegeben. Wenn dieser Parameter angegeben ist, gibt diese Funktion die Anycast-IP-Adresstabelle zurück, die IPv4- und IPv6-Einträge enthält.
AF_INET
2
 Die IPv4-Adressfamilie (Internet Protocol Version 4). Wenn dieser Parameter angegeben ist, gibt diese Funktion die Anycast-IP-Adresstabelle zurück, die nur IPv4-Einträge enthält.
AF_INET6
23
 Die IPv6-Adressfamilie (Internet Protocol Version 6). Wenn dieser Parameter angegeben ist, gibt diese Funktion die Anycast-IP-Adresstabelle zurück, die nur IPv6-Einträge enthält.

[out] Table

Ein Zeiger auf eine MIB_ANYCASTIPADDRESS_TABLE Struktur, die eine Tabelle mit Anycast-IP-Adresseinträgen auf dem lokalen Computer enthält.

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_INVALID_PARAMETER
 Es wurde ein ungültiger Parameter an die Funktion übergeben. Dieser Fehler wird zurückgegeben, wenn im Table-Parameter ein NULL-Zeiger übergeben wird oder der Family-Parameter nicht als AF_INET, AF_INET6 oder AF_UNSPEC angegeben wurde.
ERROR_NOT_ENOUGH_MEMORY
 Es sind unzureichende Arbeitsspeicherressourcen verfügbar, um den Vorgang abzuschließen.
ERROR_NOT_FOUND
 Es wurden keine Anycast-IP-Adresseinträge gefunden, wie im Family-Parameter angegeben.
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 AF_INET im Family-Parameter angegeben wurde. Dieser Fehler wird auch zurückgegeben, wenn sich kein IPv6-Stapel auf dem lokalen Computer befindet und AF_INET6 im Family-Parameter angegeben wurde. Dieser Fehler wird auch für Versionen von Windows zurückgegeben, bei denen diese Funktion nicht unterstützt wird.
Andere
 Verwenden Sie FormatMessage , um die Meldungszeichenfolge für den zurückgegebenen Fehler abzurufen.

Hinweise

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

The
Die GetAnycastIpAddressTable-Funktion listet die Anycast-IP-Adressen auf einem lokalen System auf und gibt diese Informationen in einer MIB_ANYCASTIPADDRESS_TABLE-Struktur zurück.

Die Anycast-IP-Adresseinträge werden in einer MIB_ANYCASTIPADDRESS_TABLE-Struktur im Puffer zurückgegeben, auf den der Table-Parameter verweist. Die MIB_ANYCASTIPADDRESS_TABLE-Struktur enthält eine Anycast-IP-Adresseintragsanzahl und ein Array von MIB_ANYCASTIPADDRESS_ROW Strukturen für jeden Anycast-IP-Adresseintrag. Wenn diese zurückgegebenen Strukturen nicht mehr benötigt werden, geben Sie den Arbeitsspeicher durch Aufrufen der FreeMibTable frei.

Der Family-Parameter muss entweder für AF_INET, AF_INET6 oder AF_UNSPEC initialisiert werden.

Beachten Sie, dass die zurückgegebene MIB_ANYCASTIPADDRESS_TABLE Struktur, auf die der Table-Parameter verweist, eine Auffüllung für die Ausrichtung zwischen dem NumEntries-Element und dem ersten MIB_ANYCASTIPADDRESS_ROW Arrayeintrag im Table-Element der MIB_ANYCASTIPADDRESS_TABLE-Struktur enthalten kann. Zwischen den MIB_ANYCASTIPADDRESS_ROW Arrayeinträgen kann auch ein Abstand für die Ausrichtung vorhanden sein. Bei jedem Zugriff auf einen MIB_ANYCASTIPADDRESS_ROW Arrayeintrag sollte davon ausgegangen werden, dass eine Auffüllung vorhanden ist.

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

Weitere Informationen

FreeMibTable

MIB_ANYCASTIPADDRESS_ROW

MIB_ANYCASTIPADDRESS_TABLE