PeekNamedPipe

名前付きまたは匿名パイプのデータを、パイプから取り除かずにバッファへコピーする。

PeekNamedPipe hNamedPipe, lpBuffer, nBufferSize, lpBytesRead, lpTotalBytesAvail, lpBytesLeftThisMessage

hNamedPipe : [intptr] パイプのハンドル。この引数は、CreateNamedPipe または CreateFile 関数が返す名前付きパイプインスタンスのハンドル、または CreatePipe 関数が返す匿名パイプの読み取り側のハンドルである。ハンドルはパイプへの GENERIC_READ アクセスを持っていなければならない。
lpBuffer : [intptr] パイプから読み込んだデータを受け取るバッファへのポインタ。データを読み込まない場合、この引数は NULL でもよい。
nBufferSize : [int] lpBuffer 引数で指定されたバッファのサイズ（バイト単位）。lpBuffer が NULL の場合、この引数は無視される。
lpBytesRead : [var] パイプから読み込まれたバイト数を受け取る変数へのポインタ。データを読み込まない場合、この引数は NULL でもよい。
lpTotalBytesAvail : [var] パイプから読み込める合計バイト数を受け取る変数へのポインタ。データを読み込まない場合、この引数は NULL でもよい。
lpBytesLeftThisMessage : [var] このメッセージに残るバイト数を受け取る変数へのポインタ。バイト型名前付きパイプや匿名パイプではこの引数は 0 となる。データを読み込まない場合、この引数は NULL でもよい。

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

解説

名前付きまたは匿名パイプのデータを、パイプから取り除かずにバッファへコピーする。

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

[備考]
PeekNamedPipe 関数は ReadFile 関数に似ているが、次の例外がある。
（以下省略）

情報