SetIfEntry, fonction (iphlpapi.h)

Article
08/24/2023

La fonction SetIfEntry définit les status d’administration d’une interface.

Syntaxe

IPHLPAPI_DLL_LINKAGE DWORD SetIfEntry(
  [in] PMIB_IFROW pIfRow
);

Paramètres

[in] pIfRow

Pointeur vers une structure MIB_IFROW . Le membre dwIndex de cette structure spécifie l’interface sur laquelle définir des status d’administration. Le membre dwAdminStatus spécifie la nouvelle status administrative. Le membre dwAdminStatus peut avoir l’une des valeurs suivantes.

Valeur	Signification
MIB_IF_ADMIN_STATUS_UP	L’interface est activée administrativement.
MIB_IF_ADMIN_STATUS_DOWN	L’interface est désactivée administrativement.

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 ultérieurement dans plusieurs conditions, notamment : 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 d’exécution).
ERROR_FILE_NOT_FOUND	Le système ne peut pas trouver le fichier spécifié. Cette erreur est retournée sur Windows Vista et ultérieurement si l’interface réseau spécifiée par le membre dwIndex de la structure MIB_IFROW pointée par le paramètre pIfRow est introuvable.
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 pIfRow , ou si le membre dwIndex du MIB_IFROW pointé par le paramètre pIfRow n’a pas été spécifié. Cette erreur est également retournée sur Windows Server 2003 et versions antérieures si l’interface réseau spécifiée par le membre dwIndex de la structure MIB_IFROW pointée par le paramètre pIfRow est introuvable.
ERROR_NOT_SUPPORTED	La demande n'est pas prise en charge. Cette erreur est retournée sur Windows Server 2003 et versions antérieures si aucune pile TCP/IP n’est configurée sur l’ordinateur local.
Autres	Utilisez FormatMessage pour obtenir la chaîne de message de l’erreur retournée.

Notes

La fonction SetIfEntry permet de définir la status administrative d’une interface sur un ordinateur local.

Le membre dwIndex dans la structure MIB_IFROW pointée par le paramètre pIfRow doit être initialisé dans l’index d’interface.

La fonction SetIfEntry échoue si le membre dwIndex du MIB_IFROW pointé par le paramètre pIfRow ne correspond pas à une interface existante sur l’ordinateur local.

Sur Windows Vista et versions ultérieures, la fonction SetIfEntry ne peut être appelée que par un utilisateur connecté en tant que membre du groupe Administrateurs. Si SetIfEntry 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 SetIfEntry 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 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 ensuite 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.

Spécifications


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