SetNamedPipeHandleState

指定した名前付きパイプの読み取りモードとブロッキングモードを設定する。指定ハンドルが名前付きパイプのクライアント端で、かつサーバープロセスがリモートコンピュータ上にある場合、この関数でローカルバッファリングも制御できる。

SetNamedPipeHandleState hNamedPipe, lpMode, lpMaxCollectionCount, lpCollectDataTimeout

hNamedPipe : [intptr] 名前付きパイプインスタンスへのハンドル。このパラメータには CreateNamedPipe が返すサーバー端のハンドル、または CreateFileW が返すクライアント端のハンドルを指定できる。書き込み専用や読み書きパイプでは名前付きパイプに GENERIC_WRITE アクセス権、読み取り専用パイプでは GENERIC_READ と FILE_WRITE_ATTRIBUTES アクセス権が必要である。
lpMode : [var] 新しいパイプモード。モードは読み取りモードフラグと待機モードフラグの組み合わせである。モードを設定しない場合は NULL を指定できる。次のいずれかのモードを指定する。
lpMaxCollectionCount : [var] サーバーへ送信する前にクライアントコンピュータで収集する最大バイト数。指定したパイプハンドルが名前付きパイプのサーバー端である場合、またはクライアントとサーバープロセスが同一マシン上にある場合は NULL でなければならない。ハンドル作成時にクライアントプロセスが CreateFileW で FILE_FLAG_WRITE_THROUGH を指定した場合、このパラメータは無視される。収集カウントを設定しない場合は NULL を指定できる。
lpCollectDataTimeout : [var] リモート名前付きパイプがネットワーク経由で情報を転送するまでの最大時間 (ミリ秒)。指定したパイプハンドルがサーバー端である場合、またはクライアントとサーバープロセスが同一コンピュータ上にある場合は NULL でなければならない。ハンドル作成時にクライアントプロセスが CreateFileW で FILE_FLAG_WRITE_THROUGH を指定した場合、このパラメータは無視される。収集カウントを設定しない場合は NULL を指定できる。

(プラグイン / モジュール : kernel32.dll)

解説

指定した名前付きパイプの読み取りモードとブロッキングモードを設定する。指定ハンドルが名前付きパイプのクライアント端で、かつサーバープロセスがリモートコンピュータ上にある場合、この関数でローカルバッファリングも制御できる。

[戻り値]
関数が成功した場合、戻り値は非ゼロである。失敗した場合はゼロである。拡張エラー情報を取得するには GetLastError を呼び出す。

[備考]
Windows 10 バージョン 1709: パイプは同一アプリに属する UWP プロセス間 (アプリコンテナ内)
でのみサポートされる。また名前付きパイプは `\\.\pipe\LOCAL\` という構文をパイプ名に用いる必要がある。

情報