GetNamedPipeInfo, fonction (namedpipeapi.h)

Récupère des informations sur le canal nommé spécifié.

Syntaxe

BOOL GetNamedPipeInfo(
  [in]            HANDLE  hNamedPipe,
  [out, optional] LPDWORD lpFlags,
  [out, optional] LPDWORD lpOutBufferSize,
  [out, optional] LPDWORD lpInBufferSize,
  [out, optional] LPDWORD lpMaxInstances
);

Paramètres

[in] hNamedPipe

Handle du canal nommé instance. Le handle doit avoir GENERIC_READ accès au canal nommé pour un canal en lecture seule ou en lecture/écriture, ou il doit avoir un accès GENERIC_WRITE et FILE_READ_ATTRIBUTES pour un canal en écriture seule.

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

[out, optional] lpFlags

Pointeur vers une variable qui reçoit le type du canal nommé. Ce paramètre peut être NULL si ces informations ne sont pas requises. Sinon, ce paramètre peut être une ou plusieurs des valeurs suivantes.

Valeur	Signification
PIPE_CLIENT_END 0x00000000	Le handle fait référence à l’extrémité du client d’un canal nommé instance. Il s’agit de la valeur par défaut.
PIPE_SERVER_END 0x00000001	Le handle fait référence à l’extrémité du serveur d’un canal nommé instance. Si cette valeur n’est pas spécifiée, le handle fait référence à l’extrémité cliente d’un canal nommé instance.
PIPE_TYPE_BYTE 0x00000000	Le canal nommé est un canal d’octets. Il s’agit de la valeur par défaut.
PIPE_TYPE_MESSAGE 0x00000004	Le canal nommé est un canal de messages. Si cette valeur n’est pas spécifiée, le canal est un canal d’octets.

[out, optional] lpOutBufferSize

Pointeur vers une variable qui reçoit la taille de la mémoire tampon pour les données sortantes, en octets. Si la taille de la mémoire tampon est égale à zéro, la mémoire tampon est allouée en fonction des besoins. Ce paramètre peut être NULL si ces informations ne sont pas requises.

[out, optional] lpInBufferSize

Pointeur vers une variable qui reçoit la taille de la mémoire tampon pour les données entrantes, en octets. Si la taille de la mémoire tampon est égale à zéro, la mémoire tampon est allouée en fonction des besoins. Ce paramètre peut être NULL si ces informations ne sont pas requises.

[out, optional] lpMaxInstances

Pointeur vers une variable qui reçoit le nombre maximal d’instances de canal pouvant être créées. Si la variable est définie sur PIPE_UNLIMITED_INSTANCES (255), le nombre d’instances de canal pouvant être créées est limité uniquement par la disponibilité des ressources système. Ce paramètre peut être NULL si ces informations ne sont pas requises.

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\ » pour le nom du canal.

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

Voir aussi

CreateNamedPipe

GetNamedPipeHandleState

Fonctions de canal

Vue d’ensemble des canaux