SetIpStatisticsEx-Funktion (iphlpapi.h)

Artikel
08/24/2023

Die SetIpStatisticsEx-Funktion schaltet die IP-Weiterleitung ein oder aus und legt den Standardwert für die Gültigkeitsdauer (TTL) für den lokalen Computer fest.

Syntax

IPHLPAPI_DLL_LINKAGE ULONG SetIpStatisticsEx(
  [in] PMIB_IPSTATS Statistics,
       ULONG        Family
);

Parameter

[in] Statistics

Ein Zeiger auf eine MIB_IPSTATS-Struktur . Der Aufrufer sollte die Elemente dwForwarding und dwDefaultTTL dieser Struktur auf die neuen Werte festlegen. Verwenden Sie MIB_USE_CURRENT_TTL oder MIB_USE_CURRENT_FORWARDING, um für eines der Member den aktuellen Wert beizubehalten.

Family

Die Adressfamilie, für die Weiterleitung und TTL festgelegt werden sollen.

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.

Im Windows SDK, das für Windows Vista und höher veröffentlicht wurde, wurde die organization der Headerdateien geändert, und mögliche Werte für dieses Element sind 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 und AF_INET6.

Wert	Bedeutung
AF_INET 2	Die IPv4-Adressfamilie (Internet Protocol Version 4). Wenn dieser Parameter angegeben wird, legt diese Funktion Die Weiterleitungs- und TTL-Optionen für IPv4-Einträge fest.
AF_INET6 23	Die IPv6-Adressfamilie (Internet Protocol Version 6). Wenn dieser Parameter angegeben wird, legt diese Funktion Weiterleitungs- und TTL-Optionen für IPv6-Einträge fest.

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_ACCESS_DENIED	Der Zugriff wird verweigert. Dieser Fehler wird unter folgenden Bedingungen zurückgegeben: Dem Benutzer fehlen die erforderlichen Administratorrechte auf dem lokalen Computer, oder die Anwendung wird nicht in einer erweiterten Shell als integrierter Administrator (RunAs-Administrator) ausgeführt.
ERROR_INVALID_PARAMETER	Es wurde ein ungültiger Parameter an die Funktion übergeben. Dieser Fehler wird zurückgegeben, wenn ein NULL-Zeiger im pIpStats-Parameter übergeben wird oder der Family-Parameter nicht auf AF_INET festgelegt wurde und AF_INET6. Dieser Fehler wird auch zurückgegeben, wenn der dwForwarding-Member in der MIB_IPSTATS-Struktur , auf die der pIpStats-Parameter verweist, einen anderen Wert als MIB_IP_NOT_FORWARDING, MIB_IP_FORWARDING oder MIB_USE_CURRENT_FORWARDING enthält.
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 oder sich kein IPv6-Stapel auf dem lokalen Computer befindet und AF_INET6 im Familienmitglied angegeben wurde.
Andere	Verwenden Sie FormatMessage , um die Meldungszeichenfolge für den zurückgegebenen Fehler abzurufen.

Hinweise

Um nur die Standard-TTL festzulegen, kann der Aufrufer auch die SetIpTTL-Funktion verwenden.

Die SetIpStatisticsEx-Funktion kann nur von einem Benutzer aufgerufen werden, der als Mitglied der Gruppe Administratoren angemeldet ist. Wenn SetIpStatisticsEx von einem Benutzer aufgerufen wird, der kein Mitglied der Gruppe Administratoren ist, schlägt der Funktionsaufruf fehl, und ERROR_ACCESS_DENIED wird zurückgegeben.

Die SetIpStatisticsEx-Funktion kann auch aufgrund der Benutzerkontensteuerung (User Account Control, UAC) unter Windows Vista und höher fehlschlagen. Wenn eine Anwendung, die diese Funktion enthält, von einem Benutzer ausgeführt wird, der als Mitglied der Gruppe Administratoren angemeldet ist, die nicht der integrierten Administratorgruppe angehört, schlägt dieser Aufruf fehl, es sei denn, die Anwendung wurde in der Manifestdatei mit einem requestedExecutionLevel gekennzeichnet, der auf requireAdministrator festgelegt ist. Wenn der Anwendung unter diese Manifestdatei fehlt, muss ein Benutzer, der als Mitglied der Gruppe "Administratoren" angemeldet ist als der integrierte Administrator, die Anwendung dann in einer erweiterten Shell als integrierter Administrator (RunAs-Administrator) ausführen, damit diese Funktion erfolgreich ist.

Anforderungen


Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	iphlpapi.h
Bibliothek	Iphlpapi.lib
DLL	Iphlpapi.dll