CallNamedPipeW

メッセージ型パイプに接続し(インスタンスが利用できない場合は待機する)、パイプへの書き込みと読み込みを行い、パイプを閉じる。(CallNamedPipeW)

CallNamedPipeW lpNamedPipeName, lpInBuffer, nInBufferSize, lpOutBuffer, nOutBufferSize, lpBytesRead, nTimeOut

lpNamedPipeName : [wstr] パイプ名。
lpInBuffer : [intptr] パイプに書き込むデータ。
nInBufferSize : [int] 書き込みバッファのサイズ(バイト単位)。
lpOutBuffer : [intptr] パイプから読み込んだデータを受け取るバッファへのポインタ。
nOutBufferSize : [int] 読み込みバッファのサイズ(バイト単位)。
lpBytesRead : [var] パイプから読み込まれたバイト数を受け取る変数へのポインタ。
nTimeOut : [int] 名前付きパイプが利用可能になるまで待機するミリ秒数。数値に加え、以下の特殊値も指定できる。

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

解説

メッセージ型パイプに接続し(インスタンスが利用できない場合は待機する)、パイプへの書き込みと読み込みを行い、パイプを閉じる。(CallNamedPipeW)

[戻り値]
関数が成功した場合、戻り値はゼロ以外。関数が失敗した場合、戻り値はゼロ。拡張エラー情報を取得するには GetLastError
を呼ぶ。サーバープロセスがパイプに書き込んだメッセージが nOutBufferSize より長い場合、CallNamedPipe は
FALSE を返し、GetLastError は ERROR_MORE_DATA を返す。CallNamedPipe
は戻る前にパイプへのハンドルを閉じるため、メッセージの残りは破棄される。

[備考]
CallNamedPipe を呼ぶことは、CreateFile(CreateFile が直ちにパイプを開けない場合は
WaitNamedPipe)、TransactNamedPipeCloseHandle
の各関数を呼ぶのと同等である。CreateFile はアクセスフラグ GENERIC_READ |
GENERIC_WRITE、継承ハンドルフラグ FALSE で呼ばれる。パイプがバイト型パイプの場合、CallNamedPipe
は失敗する。Windows 10 バージョン 1709: パイプは app-container 内でのみサポートされ、つまり同じアプリの
UWP プロセス間でしか使えない。また、名前付きパイプはパイプ名に `\\.\pipe\LOCAL\` 構文を使う必要がある。

情報

プラグイン / モジュールkernel32.dll
バージョン1.0
作成日2026/04/16
著作者IronHSP / CsWin32 bridge
URLhttps://github.com/inovia/IronHSP
備考Win32 API の kernel32.dll 関数群。CsWin32 + win32metadata から自動生成。
hsp3net 専用 (intptr / NSTRUCT / wstr を使用)。
タイプ拡張命令
グループWin32API
対応環境
  • Windows 版 HSP
hs ファイルhsphelp\win32_kernel32_gen2.hs