Fonction SetIpStatistics (iphlpapi.h)

Article
08/24/2023

La fonction SetIpStatistics active ou désactive le transfert IP et définit la valeur de durée de vie (TTL) par défaut pour l’ordinateur local.

Syntaxe

IPHLPAPI_DLL_LINKAGE DWORD SetIpStatistics(
  [in] PMIB_IPSTATS pIpStats
);

Paramètres

[in] pIpStats

Pointeur vers une structure MIB_IPSTATS . L’appelant doit définir les membres dwForwarding et dwDefaultTTL de cette structure sur les nouvelles valeurs. Pour conserver l’un des membres à sa valeur actuelle, utilisez MIB_USE_CURRENT_TTL ou MIB_USE_CURRENT_FORWARDING.

Valeur retournée

Si la fonction réussit, la valeur de retour est NO_ERROR.

Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants.

Code de retour	Description
ERROR_ACCESS_DENIED	Accès refusé. Cette erreur est retournée sur Windows Vista et Windows Server 2008 dans plusieurs conditions qui incluent les suivantes : l’utilisateur n’a pas les privilèges d’administration requis sur l’ordinateur local ou l’application ne s’exécute pas dans un interpréteur de commandes amélioré en tant qu’administrateur intégré (administrateur runas).
ERROR_INVALID_PARAMETER	Un paramètre non valide a été transmis à la fonction. Cette erreur est retournée si un pointeur NULL est passé dans le paramètre pIpStats . Cette erreur est également retournée si le membre dwForwarding dans la structure MIB_IPSTATS pointée par le paramètre pIpStats contient une valeur autre que MIB_IP_NOT_FORWARDING, MIB_IP_FORWARDING ou MIB_USE_CURRENT_FORWARDING.
Autres	Utilisez FormatMessage pour obtenir la chaîne de message pour l’erreur retournée.

Notes

Pour définir uniquement la durée de vie par défaut, l’appelant peut également utiliser la fonction SetIpTTL .

Sur Windows Vista et versions ultérieures, la fonction SetIpStatistics ne peut être appelée que par un utilisateur connecté en tant que membre du groupe Administrateurs. Si SetIpStatistics est appelé par un utilisateur qui n’est pas membre du groupe Administrateurs, l’appel de fonction échoue et ERROR_ACCESS_DENIED est retourné.

La fonction SetIpStatistics peut également échouer en raison du contrôle de compte d’utilisateur (UAC) sur Windows Vista et versions ultérieures. Si une application qui contient cette fonction est exécutée par un utilisateur connecté en tant que membre du groupe Administrateurs autre que l’administrateur intégré, cet appel échoue, sauf si l’application a été marquée dans le fichier manifeste avec un paramètre requestedExecutionLevel défini sur requireAdministrator. Si l’application ne dispose pas de ce fichier manifeste, un utilisateur connecté en tant que membre du groupe Administrateurs autre que l’administrateur intégré doit alors exécuter l’application dans un interpréteur de commandes amélioré en tant qu’administrateur intégré (administrateur d’exécution) pour que cette fonction réussisse.

Note Sur Windows NT 4.0 et Windows 2000 et versions ultérieures, cette fonction exécute une opération privilégiée. Pour que cette fonction s’exécute correctement, l’appelant doit être connecté en tant que membre du groupe Administrateurs ou du groupe NetworkConfigurationOperators.

Configuration requise


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	iphlpapi.h
Bibliothèque	Iphlpapi.lib
DLL	Iphlpapi.dll