structure FILE_PIPE_LOCAL_INFORMATION (ntifs.h)

  • Article

La structure FILE_PIPE_LOCAL_INFORMATION contient des informations sur l’extrémité locale d’un canal nommé.

Syntaxe

typedef struct _FILE_PIPE_LOCAL_INFORMATION {
  ULONG NamedPipeType;
  ULONG NamedPipeConfiguration;
  ULONG MaximumInstances;
  ULONG CurrentInstances;
  ULONG InboundQuota;
  ULONG ReadDataAvailable;
  ULONG OutboundQuota;
  ULONG WriteQuotaAvailable;
  ULONG NamedPipeState;
  ULONG NamedPipeEnd;
} FILE_PIPE_LOCAL_INFORMATION, *PFILE_PIPE_LOCAL_INFORMATION;

Membres

NamedPipeType

L’un des types de canaux nommés suivants.

Valeur Signification
FILE_PIPE_BYTE_STREAM_TYPE (0x00000000) Les données sont lues à partir du canal sous forme de flux d’octets.
FILE_PIPE_MESSAGE_TYPE (0x00000001) Les données sont lues à partir du canal en tant que flux de messages.

NamedPipeConfiguration

Une des configurations de canal nommées suivantes.

Valeur Signification
FILE_PIPE_INBOUND (0x00000000) Le flux de données dans le canal passe uniquement du client au serveur.
FILE_PIPE_OUTBOUND (0x00000001) Le flux de données dans le canal va du serveur au client uniquement.
FILE_PIPE_FULL_DUPLEX (0x00000002) Le canal est bidirectionnel ; Les processus serveur et client peuvent lire et écrire dans le canal.

MaximumInstances

Nombre maximal d’instances qui peuvent être créées pour ce canal. La première instance du canal doit spécifier cette valeur.

CurrentInstances

Nombre d’instances de canal nommées actuelles.

InboundQuota

Quota entrant, en octets, pour le canal nommé.

ReadDataAvailable

Quantité de données disponibles, en octets, à lire à partir du canal nommé.

OutboundQuota

Quota sortant, en octets, pour le canal nommé.

WriteQuotaAvailable

Quota d’écriture, en octets, pour le canal nommé.

NamedPipeState

La connexion status pour le canal nommé. Cet état a l’une des valeurs suivantes.

Valeur Signification
FILE_PIPE_DISCONNECTED_STATE (0x00000001) Le canal nommé est déconnecté.
FILE_PIPE_LISTENING_STATE (0x00000002) Le canal nommé attend d’établir une connexion.
FILE_PIPE_CONNECTED_STATE (0x00000003) Le canal nommé est connecté.
FILE_PIPE_CLOSING_STATE (0x00000004) Le canal nommé est en cours de fermeture.

NamedPipeEnd

Type de l’extrémité du canal nommé, qui spécifie s’il s’agit du côté client ou du côté serveur d’un canal nommé.

Valeur Signification
FILE_PIPE_CLIENT_END (0x00000000) Il s’agit de l’extrémité cliente d’un canal nommé.
FILE_PIPE_SERVER_END (0x00000001) Il s’agit de l’extrémité serveur d’un canal nommé.

Remarques

Pour plus d’informations sur les canaux, consultez Canaux.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000
En-tête ntifs.h (include FltKernel.h, Ntifs.h)