SetTcpEntry, fonction (iphlpapi.h)

La fonction SetTcpEntry définit l’état d’une connexion TCP.

Syntaxe

IPHLPAPI_DLL_LINKAGE DWORD SetTcpEntry(
  [in] PMIB_TCPROW pTcpRow
);

Paramètres

[in] pTcpRow

Pointeur vers une structure MIB_TCPROW . Cette structure spécifie les informations permettant d’identifier la connexion TCP à modifier. Il spécifie également le nouvel état de la connexion TCP. L’appelant doit spécifier des valeurs pour tous les membres de cette structure.

Valeur retournée

La fonction retourne NO_ERROR (zéro) si la fonction réussit.

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

Code/valeur de retour Description
ERROR_ACCESS_DENIED
L’accès est refusé. Cette erreur est retournée sur Windows Vista et Windows Server 2008 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 RunAs).
ERROR_INVALID_PARAMETER
Un paramètre d’entrée n’est pas valide, aucune action n’a été effectuée. Cette erreur est retournée si le paramètre pTcpRow a la valeur NULL ou si le membre Row dans la structure MIB_TCPROW pointée par le paramètre pTcpRow n’est pas défini sur MIB_TCP_STATE_DELETE_TCB.
ERROR_NOT_SUPPORTED
Le transport IPv4 n’est pas configuré sur l’ordinateur local.
317
La fonction ne peut pas définir l’entrée TCP, car l’application s’exécute sans élévation de privilèges.
Autres
Utilisez FormatMessage pour obtenir la chaîne de message de l’erreur retournée.

Remarques

Actuellement, le seul état auquel une connexion TCP peut être définie est MIB_TCP_STATE_DELETE_TCB.

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

Configuration requise

Condition requise Valeur
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

Voir aussi

Informations de référence sur les fonctions d’assistance IP

Page de démarrage de l’assistance IP

MIB_TCPROW