DisconnectNamedPipe, fonction (namedpipeapi.h)

Article
02/29/2024

Déconnecte l’extrémité du serveur d’un canal nommé instance d’un processus client.

Syntaxe

BOOL DisconnectNamedPipe(
  [in] HANDLE hNamedPipe
);

Paramètres

[in] hNamedPipe

Handle vers un instance d’un canal nommé. Ce handle doit être créé par la fonction CreateNamedPipe .

Valeur retournée

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Si l’extrémité cliente du canal nommé est ouverte, la fonction DisconnectNamedPipe force cette fin du canal nommé à se fermer. Le client reçoit une erreur la prochaine fois qu’il tente d’accéder au canal. Un client qui est forcé de quitter un canal par DisconnectNamedPipe doit toujours utiliser la fonction CloseHandle pour fermer sa fin du canal.

Le canal existe tant qu’un processus serveur ou client a un handle ouvert pour le canal.

Lorsque le processus serveur déconnecte un canal instance, toutes les données non lues dans le canal sont ignorées. Avant de se déconnecter, le serveur peut s’assurer que les données ne sont pas perdues en appelant la fonction FlushFileBuffers , qui ne retourne pas tant que le processus client n’a pas lu toutes les données.

Le processus serveur doit appeler DisconnectNamedPipe pour déconnecter un handle de canal de son client précédent avant que le handle puisse être connecté à un autre client à l’aide de la fonction ConnectNamedPipe .

Windows 10, version 1709 : les canaux ne sont pris en charge que dans un conteneur d’application, c’est-à-dire, d’un processus UWP à un autre processus UWP qui fait partie de la même application. En outre, les canaux nommés doivent utiliser la syntaxe \\.\pipe\LOCAL\ du nom du canal.

Exemples

Pour obtenir un exemple, consultez Serveur de canal multithread.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	namedpipeapi.h
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll