FILE_PIPE_LOCAL_INFORMATION 構造体 (ntifs.h)

FILE_PIPE_LOCAL_INFORMATION構造体には、名前付きパイプのローカル終端に関する情報が含まれています。

構文

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;

メンバー

NamedPipeType

次のいずれかの名前付きパイプの種類。

値	意味
FILE_PIPE_BYTE_STREAM_TYPE (0x00000000)	データは、パイプからバイト ストリームとして読み取られます。
FILE_PIPE_MESSAGE_TYPE (0x00000001)	データは、メッセージのストリームとしてパイプから読み取られます。

NamedPipeConfiguration

次のいずれかの名前付きパイプ構成。

値	意味
FILE_PIPE_INBOUND (0x00000000)	パイプ内のデータフローは、クライアントからサーバーにのみ送信されます。
FILE_PIPE_OUTBOUND (0x00000001)	パイプ内のデータフローは、サーバーからクライアントにのみ送信されます。
FILE_PIPE_FULL_DUPLEX (0x00000002)	パイプは双方向です。サーバー プロセスとクライアント プロセスの両方で、パイプとの間で読み取りと書き込みを行うことができます。

MaximumInstances

このパイプに対して作成できるインスタンスの最大数。 パイプの最初のインスタンスでは、この値を指定する必要があります。

CurrentInstances

現在の名前付きパイプ インスタンスの数。

InboundQuota

名前付きパイプの受信クォータ (バイト単位)。

ReadDataAvailable

名前付きパイプから読み取ることができるデータの量 (バイト単位)。

OutboundQuota

名前付きパイプの送信クォータ (バイト単位)。

WriteQuotaAvailable

名前付きパイプの書き込みクォータ (バイト単位)。

NamedPipeState

名前付きパイプの接続状態。 この状態には、次のいずれかの値があります。

値	意味
FILE_PIPE_DISCONNECTED_STATE (0x00000001)	名前付きパイプが切断されています。
FILE_PIPE_LISTENING_STATE (0x00000002)	名前付きパイプは接続の確立を待機しています。
FILE_PIPE_CONNECTED_STATE (0x00000003)	名前付きパイプが接続されています。
FILE_PIPE_CLOSING_STATE (0x00000004)	名前付きパイプは閉じられている処理中です。

NamedPipeEnd

名前付きパイプの末尾の型。これは、名前付きパイプのクライアント側かサーバー側かを指定します。

値	意味
FILE_PIPE_CLIENT_END (0x00000000)	これは、名前付きパイプのクライアント側です。
FILE_PIPE_SERVER_END (0x00000001)	これは、名前付きパイプのサーバー側です。

注釈

パイプの詳細については、「 パイプ」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 2000
Header	ntifs.h (FltKernel.h、Ntifs.h を含む)