Win32 API 日本語リファレンス
ホームSystem.Pipes › PeekNamedPipe

PeekNamedPipe

関数
パイプ内のデータを削除せずに先読みする。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL PeekNamedPipe(
    HANDLE hNamedPipe,
    void* lpBuffer,   // optional
    DWORD nBufferSize,
    DWORD* lpBytesRead,   // optional
    DWORD* lpTotalBytesAvail,   // optional
    DWORD* lpBytesLeftThisMessage   // optional
);

パラメーター

名前方向
hNamedPipeHANDLEin
lpBuffervoid*outoptional
nBufferSizeDWORDin
lpBytesReadDWORD*outoptional
lpTotalBytesAvailDWORD*outoptional
lpBytesLeftThisMessageDWORD*outoptional

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL PeekNamedPipe(
    HANDLE hNamedPipe,
    void* lpBuffer,   // optional
    DWORD nBufferSize,
    DWORD* lpBytesRead,   // optional
    DWORD* lpTotalBytesAvail,   // optional
    DWORD* lpBytesLeftThisMessage   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool PeekNamedPipe(
    IntPtr hNamedPipe,   // HANDLE
    IntPtr lpBuffer,   // void* optional, out
    uint nBufferSize,   // DWORD
    IntPtr lpBytesRead,   // DWORD* optional, out
    IntPtr lpTotalBytesAvail,   // DWORD* optional, out
    IntPtr lpBytesLeftThisMessage   // DWORD* optional, out
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PeekNamedPipe(
    hNamedPipe As IntPtr,   ' HANDLE
    lpBuffer As IntPtr,   ' void* optional, out
    nBufferSize As UInteger,   ' DWORD
    lpBytesRead As IntPtr,   ' DWORD* optional, out
    lpTotalBytesAvail As IntPtr,   ' DWORD* optional, out
    lpBytesLeftThisMessage As IntPtr   ' DWORD* optional, out
) As Boolean
End Function
' hNamedPipe : HANDLE
' lpBuffer : void* optional, out
' nBufferSize : DWORD
' lpBytesRead : DWORD* optional, out
' lpTotalBytesAvail : DWORD* optional, out
' lpBytesLeftThisMessage : DWORD* optional, out
Declare PtrSafe Function PeekNamedPipe Lib "kernel32" ( _
    ByVal hNamedPipe As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByVal nBufferSize As Long, _
    ByVal lpBytesRead As LongPtr, _
    ByVal lpTotalBytesAvail As LongPtr, _
    ByVal lpBytesLeftThisMessage As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PeekNamedPipe = ctypes.windll.kernel32.PeekNamedPipe
PeekNamedPipe.restype = wintypes.BOOL
PeekNamedPipe.argtypes = [
    wintypes.HANDLE,  # hNamedPipe : HANDLE
    ctypes.POINTER(None),  # lpBuffer : void* optional, out
    wintypes.DWORD,  # nBufferSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpBytesRead : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpTotalBytesAvail : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpBytesLeftThisMessage : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
PeekNamedPipe = Fiddle::Function.new(
  lib['PeekNamedPipe'],
  [
    Fiddle::TYPE_VOIDP,  # hNamedPipe : HANDLE
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* optional, out
    -Fiddle::TYPE_INT,  # nBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # lpBytesRead : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpTotalBytesAvail : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpBytesLeftThisMessage : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn PeekNamedPipe(
        hNamedPipe: *mut core::ffi::c_void,  // HANDLE
        lpBuffer: *mut (),  // void* optional, out
        nBufferSize: u32,  // DWORD
        lpBytesRead: *mut u32,  // DWORD* optional, out
        lpTotalBytesAvail: *mut u32,  // DWORD* optional, out
        lpBytesLeftThisMessage: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool PeekNamedPipe(IntPtr hNamedPipe, IntPtr lpBuffer, uint nBufferSize, IntPtr lpBytesRead, IntPtr lpTotalBytesAvail, IntPtr lpBytesLeftThisMessage);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_PeekNamedPipe' -Namespace Win32 -PassThru
# $api::PeekNamedPipe(hNamedPipe, lpBuffer, nBufferSize, lpBytesRead, lpTotalBytesAvail, lpBytesLeftThisMessage)
#uselib "KERNEL32.dll"
#func global PeekNamedPipe "PeekNamedPipe" sptr, sptr, sptr, sptr, sptr, sptr
; PeekNamedPipe hNamedPipe, lpBuffer, nBufferSize, varptr(lpBytesRead), varptr(lpTotalBytesAvail), varptr(lpBytesLeftThisMessage)   ; 戻り値は stat
; hNamedPipe : HANDLE -> "sptr"
; lpBuffer : void* optional, out -> "sptr"
; nBufferSize : DWORD -> "sptr"
; lpBytesRead : DWORD* optional, out -> "sptr"
; lpTotalBytesAvail : DWORD* optional, out -> "sptr"
; lpBytesLeftThisMessage : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global PeekNamedPipe "PeekNamedPipe" sptr, sptr, int, var, var, var
; res = PeekNamedPipe(hNamedPipe, lpBuffer, nBufferSize, lpBytesRead, lpTotalBytesAvail, lpBytesLeftThisMessage)
; hNamedPipe : HANDLE -> "sptr"
; lpBuffer : void* optional, out -> "sptr"
; nBufferSize : DWORD -> "int"
; lpBytesRead : DWORD* optional, out -> "var"
; lpTotalBytesAvail : DWORD* optional, out -> "var"
; lpBytesLeftThisMessage : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL PeekNamedPipe(HANDLE hNamedPipe, void* lpBuffer, DWORD nBufferSize, DWORD* lpBytesRead, DWORD* lpTotalBytesAvail, DWORD* lpBytesLeftThisMessage)
#uselib "KERNEL32.dll"
#cfunc global PeekNamedPipe "PeekNamedPipe" intptr, intptr, int, var, var, var
; res = PeekNamedPipe(hNamedPipe, lpBuffer, nBufferSize, lpBytesRead, lpTotalBytesAvail, lpBytesLeftThisMessage)
; hNamedPipe : HANDLE -> "intptr"
; lpBuffer : void* optional, out -> "intptr"
; nBufferSize : DWORD -> "int"
; lpBytesRead : DWORD* optional, out -> "var"
; lpTotalBytesAvail : DWORD* optional, out -> "var"
; lpBytesLeftThisMessage : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procPeekNamedPipe = kernel32.NewProc("PeekNamedPipe")
)

// hNamedPipe (HANDLE), lpBuffer (void* optional, out), nBufferSize (DWORD), lpBytesRead (DWORD* optional, out), lpTotalBytesAvail (DWORD* optional, out), lpBytesLeftThisMessage (DWORD* optional, out)
r1, _, err := procPeekNamedPipe.Call(
	uintptr(hNamedPipe),
	uintptr(lpBuffer),
	uintptr(nBufferSize),
	uintptr(lpBytesRead),
	uintptr(lpTotalBytesAvail),
	uintptr(lpBytesLeftThisMessage),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function PeekNamedPipe(
  hNamedPipe: THandle;   // HANDLE
  lpBuffer: Pointer;   // void* optional, out
  nBufferSize: DWORD;   // DWORD
  lpBytesRead: Pointer;   // DWORD* optional, out
  lpTotalBytesAvail: Pointer;   // DWORD* optional, out
  lpBytesLeftThisMessage: Pointer   // DWORD* optional, out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'PeekNamedPipe';
result := DllCall("KERNEL32\PeekNamedPipe"
    , "Ptr", hNamedPipe   ; HANDLE
    , "Ptr", lpBuffer   ; void* optional, out
    , "UInt", nBufferSize   ; DWORD
    , "Ptr", lpBytesRead   ; DWORD* optional, out
    , "Ptr", lpTotalBytesAvail   ; DWORD* optional, out
    , "Ptr", lpBytesLeftThisMessage   ; DWORD* optional, out
    , "Int")   ; return: BOOL
●PeekNamedPipe(hNamedPipe, lpBuffer, nBufferSize, lpBytesRead, lpTotalBytesAvail, lpBytesLeftThisMessage) = DLL("KERNEL32.dll", "bool PeekNamedPipe(void*, void*, dword, void*, void*, void*)")
# 呼び出し: PeekNamedPipe(hNamedPipe, lpBuffer, nBufferSize, lpBytesRead, lpTotalBytesAvail, lpBytesLeftThisMessage)
# hNamedPipe : HANDLE -> "void*"
# lpBuffer : void* optional, out -> "void*"
# nBufferSize : DWORD -> "dword"
# lpBytesRead : DWORD* optional, out -> "void*"
# lpTotalBytesAvail : DWORD* optional, out -> "void*"
# lpBytesLeftThisMessage : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。