GetNamedPipeInfo 関数 (namedpipeapi.h)

  • [アーティクル]

指定した名前付きパイプに関する情報を取得します。

構文

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

パラメーター

[in] hNamedPipe

名前付きパイプ インスタンスへのハンドル。 ハンドルは、読み取り専用パイプまたは読み取り/書き込みパイプの名前付きパイプにGENERIC_READアクセスできる必要があります。または、書き込み専用パイプのGENERIC_WRITEとFILE_READ_ATTRIBUTESアクセス権が必要です。

このパラメーターは、 CreatePipe 関数によって返される匿名パイプへのハンドルにすることもできます。

[out, optional] lpFlags

名前付きパイプの型を受け取る変数へのポインター。 この情報が不要な場合、このパラメーターは NULL にすることができます。 それ以外の場合、このパラメーターには次の値の 1 つ以上を指定できます。

値 意味
PIPE_CLIENT_END
0x00000000
 ハンドルは、名前付きパイプ インスタンスのクライアント側を参照します。 既定値です。
PIPE_SERVER_END
0x00000001
 ハンドルは、名前付きパイプ インスタンスのサーバー側を参照します。 この値を指定しない場合、ハンドルは名前付きパイプ インスタンスのクライアント側を参照します。
PIPE_TYPE_BYTE
0x00000000
 名前付きパイプはバイト パイプです。 既定値です。
PIPE_TYPE_MESSAGE
0x00000004
 名前付きパイプはメッセージ パイプです。 この値を指定しない場合、パイプはバイト パイプになります。

[out, optional] lpOutBufferSize

送信データのバッファーのサイズをバイト単位で受け取る変数へのポインター。 バッファー サイズが 0 の場合、バッファーは必要に応じて割り当てられます。 この情報が不要な場合、このパラメーターは NULL にすることができます。

[out, optional] lpInBufferSize

受信データのバッファーのサイズをバイト単位で受け取る変数へのポインター。 バッファー サイズが 0 の場合、バッファーは必要に応じて割り当てられます。 この情報が不要な場合、このパラメーターは NULL にすることができます。

[out, optional] lpMaxInstances

作成できるパイプ インスタンスの最大数を受け取る変数へのポインター。 変数が PIPE_UNLIMITED_INSTANCES (255) に設定されている場合、作成できるパイプ インスタンスの数は、システム リソースの可用性によってのみ制限されます。 この情報が不要な場合、このパラメーターは NULL にすることができます。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

Windows 10バージョン 1709: パイプは、アプリ コンテナー内でのみサポートされます。つまり、1 つの UWP プロセスから、同じアプリの一部である別の UWP プロセスまでです。 また、名前付きパイプでは、パイプ名に構文 "\\.\pipe\LOCAL\" を使用する必要があります。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー namedpipeapi.h
Library Kernel32.lib
[DLL] Kernel32.dll

関連項目

CreateNamedPipe

GetNamedPipeHandleState

パイプ関数

パイプの概要