WNetCancelConnection2A, fonction (winnetwk.h)

Article
03/08/2023

La fonction WNetCancelConnection2 annule une connexion réseau existante. Vous pouvez également appeler la fonction pour supprimer les connexions réseau mémorisées qui ne sont pas actuellement connectées.

La fonction WNetCancelConnection2 remplace la fonction WNetCancelConnection .

Syntaxe

DWORD WNetCancelConnection2A(
  [in] LPCSTR lpName,
  [in] DWORD  dwFlags,
  [in] BOOL   fForce
);

Paramètres

[in] lpName

Pointeur vers une chaîne null constante qui spécifie le nom de l’appareil local redirigé ou de la ressource réseau distante à déconnecter.

Si ce paramètre spécifie un appareil local redirigé, la fonction annule uniquement la redirection d’appareil spécifiée. Si le paramètre spécifie une ressource réseau distante, toutes les connexions sans appareils sont annulées.

[in] dwFlags

Type de connexion Les valeurs suivantes sont définies.

Valeur	Signification
0	Le système ne met pas à jour les informations sur la connexion. Si la connexion a été marquée comme persistante dans le Registre, le système continue de restaurer la connexion à la prochaine ouverture de session. Si la connexion n’a pas été marquée comme persistante, la fonction ignore le paramètre de l’indicateur CONNECT_UPDATE_PROFILE.
CONNECT_UPDATE_PROFILE	Le système met à jour le profil utilisateur avec les informations indiquant que la connexion n’est plus persistante. Le système ne restaurera pas cette connexion lors des opérations d’ouverture de session suivantes. (La déconnexion des ressources à l’aide de noms distants n’a aucun effet sur les connexions persistantes.)

[in] fForce

Spécifie si la déconnexion doit se produire s’il existe des fichiers ou des travaux ouverts sur la connexion. Si ce paramètre a la valeur FALSE, la fonction échoue s’il existe des fichiers ou des travaux ouverts.

Valeur retournée

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

Si la fonction échoue, la valeur de retour est un code d’erreur système, tel qu’une des valeurs suivantes.

Code de retour	Description
ERROR_BAD_PROFILE	Le profil utilisateur est dans un format incorrect.
ERROR_CANNOT_OPEN_PROFILE	Le système ne peut pas ouvrir le profil utilisateur pour traiter les connexions persistantes.
ERROR_DEVICE_IN_USE	L’appareil est utilisé par un processus actif et ne peut pas être déconnecté.
ERROR_EXTENDED_ERROR	Une erreur spécifique au réseau s’est produite. Pour obtenir une description de l’erreur, appelez la fonction WNetGetLastError .
ERROR_NOT_CONNECTED	Le nom spécifié par le paramètre lpName n’est pas un appareil redirigé, ou le système n’est actuellement pas connecté à l’appareil spécifié par le paramètre.
ERROR_OPEN_FILES	Il existe des fichiers ouverts et le paramètre fForce est FALSE.

Remarques

Windows Server 2003 et Windows XP : Les fonctions WNet créent et suppriment des lettres de lecteur réseau dans l’espace de noms d’appareil MS-DOS associé à une session d’ouverture de session, car les appareils MS-DOS sont identifiés par AuthenticationID. (Un AuthenticationID est l’identificateur local unique, ou LUID, associé à une session d’ouverture de session.) Cela peut affecter les applications qui appellent l’une des fonctions WNet pour créer une lettre de lecteur réseau sous une ouverture de session utilisateur, mais qui interrogent les lettres de lecteur réseau existantes sous une autre ouverture de session utilisateur. Un exemple de cette situation peut être lorsque la deuxième ouverture de session d’un utilisateur est créée au sein d’une session d’ouverture de session, par exemple, en appelant la fonction CreateProcessAsUser , et que la deuxième ouverture de session exécute une application qui appelle la fonction GetLogicalDrives . GetLogicalDrives ne retourne pas de lettres de lecteur réseau créées par une fonction WNet sous la première ouverture de session. Notez que dans l’exemple précédent, la première session d’ouverture de session existe toujours et que l’exemple peut s’appliquer à n’importe quelle session d’ouverture de session, y compris une session des services Terminal Server. Pour plus d’informations, consultez Définition d’un nom d’appareil MS-DOS.

Exemples

Pour obtenir un exemple de code qui montre comment annuler une connexion à une ressource réseau avec un appel à la fonction WNetCancelConnection2 , consultez Annulation d’une connexion réseau.

Notes

L’en-tête winnetwk.h définit WNetCancelConnection2 comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

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	winnetwk.h
Bibliothèque	Mpr.lib
DLL	Mpr.dll