SetNamedPipeHandleState, fonction (namedpipeapi.h)

Définit le mode lecture et le mode de blocage du canal nommé spécifié. Si le handle spécifié se trouve à l’extrémité cliente d’un canal nommé et si le processus serveur de canal nommé se trouve sur un ordinateur distant, la fonction peut également être utilisée pour contrôler la mise en mémoire tampon locale.

Syntaxe

BOOL SetNamedPipeHandleState(
  [in]           HANDLE  hNamedPipe,
  [in, optional] LPDWORD lpMode,
  [in, optional] LPDWORD lpMaxCollectionCount,
  [in, optional] LPDWORD lpCollectDataTimeout
);

Paramètres

[in] hNamedPipe

Handle du canal nommé instance. Ce paramètre peut être un handle à l’extrémité du serveur du canal, comme retourné par la fonction CreateNamedPipe , ou à l’extrémité cliente du canal, comme retourné par la fonction CreateFile . Le handle doit avoir GENERIC_WRITE accès au canal nommé pour un canal en écriture seule ou en lecture/écriture, ou il doit disposer d’un accès GENERIC_READ et FILE_WRITE_ATTRIBUTES pour un canal en lecture seule.

Ce paramètre peut également être un handle vers un canal anonyme, tel que retourné par la fonction CreatePipe .

[in, optional] lpMode

Nouveau mode de canal. Le mode est une combinaison d’un indicateur de mode lecture et d’un indicateur de mode d’attente. Ce paramètre peut être NULL si le mode n’est pas défini. Spécifiez l’un des modes suivants.

L’un des modes d’attente suivants peut être spécifié.

[in, optional] lpMaxCollectionCount

Nombre maximal d’octets collectés sur l’ordinateur client avant la transmission au serveur. Ce paramètre doit avoir la valeur NULL si le handle de canal spécifié se trouve à l’extrémité du serveur d’un canal nommé ou si les processus client et serveur se trouvent sur la même machine. Ce paramètre est ignoré si le processus client spécifie l’indicateur FILE_FLAG_WRITE_THROUGH dans la fonction CreateFile lors de la création du handle. Ce paramètre peut être NULL si le nombre de collections n’est pas défini.

[in, optional] lpCollectDataTimeout

Durée maximale, en millisecondes, qui peut passer avant qu’un canal nommé distant transfère des informations sur le réseau. Ce paramètre doit être NULL si le handle de canal spécifié se trouve à l’extrémité du serveur d’un canal nommé ou si les processus client et serveur se trouvent sur le même ordinateur. Ce paramètre est ignoré si le processus client a spécifié l’indicateur FILE_FLAG_WRITE_THROUGH dans la fonction CreateFile lors de la création du handle. Ce paramètre peut être NULL si le nombre de collections n’est pas défini.

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

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 Client de canal nommé.

Configuration requise

Voir aussi

ConnectNamedPipe

CreateFile

CreateNamedPipe

GetNamedPipeHandleState

Fonctions de canal

Vue d’ensemble des canaux

ReadFile

WriteFile