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

TransactNamedPipe

関数
名前付きパイプへの書き込みと読み取りを一括実行する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL TransactNamedPipe(
    HANDLE hNamedPipe,
    void* lpInBuffer,   // optional
    DWORD nInBufferSize,
    void* lpOutBuffer,   // optional
    DWORD nOutBufferSize,
    DWORD* lpBytesRead,
    OVERLAPPED* lpOverlapped   // optional
);

パラメーター

名前方向
hNamedPipeHANDLEin
lpInBuffervoid*inoptional
nInBufferSizeDWORDin
lpOutBuffervoid*outoptional
nOutBufferSizeDWORDin
lpBytesReadDWORD*out
lpOverlappedOVERLAPPED*inoutoptional

戻り値の型: BOOL

各言語での呼び出し定義

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

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

TransactNamedPipe = ctypes.windll.kernel32.TransactNamedPipe
TransactNamedPipe.restype = wintypes.BOOL
TransactNamedPipe.argtypes = [
    wintypes.HANDLE,  # hNamedPipe : HANDLE
    ctypes.POINTER(None),  # lpInBuffer : void* optional
    wintypes.DWORD,  # nInBufferSize : DWORD
    ctypes.POINTER(None),  # lpOutBuffer : void* optional, out
    wintypes.DWORD,  # nOutBufferSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpBytesRead : DWORD* out
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED* optional, in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
TransactNamedPipe = Fiddle::Function.new(
  lib['TransactNamedPipe'],
  [
    Fiddle::TYPE_VOIDP,  # hNamedPipe : HANDLE
    Fiddle::TYPE_VOIDP,  # lpInBuffer : void* optional
    -Fiddle::TYPE_INT,  # nInBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # lpOutBuffer : void* optional, out
    -Fiddle::TYPE_INT,  # nOutBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # lpBytesRead : DWORD* out
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED* optional, in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn TransactNamedPipe(
        hNamedPipe: *mut core::ffi::c_void,  // HANDLE
        lpInBuffer: *mut (),  // void* optional
        nInBufferSize: u32,  // DWORD
        lpOutBuffer: *mut (),  // void* optional, out
        nOutBufferSize: u32,  // DWORD
        lpBytesRead: *mut u32,  // DWORD* out
        lpOverlapped: *mut OVERLAPPED  // OVERLAPPED* optional, in/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 TransactNamedPipe(IntPtr hNamedPipe, IntPtr lpInBuffer, uint nInBufferSize, IntPtr lpOutBuffer, uint nOutBufferSize, out uint lpBytesRead, IntPtr lpOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_TransactNamedPipe' -Namespace Win32 -PassThru
# $api::TransactNamedPipe(hNamedPipe, lpInBuffer, nInBufferSize, lpOutBuffer, nOutBufferSize, lpBytesRead, lpOverlapped)
#uselib "KERNEL32.dll"
#func global TransactNamedPipe "TransactNamedPipe" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; TransactNamedPipe hNamedPipe, lpInBuffer, nInBufferSize, lpOutBuffer, nOutBufferSize, varptr(lpBytesRead), varptr(lpOverlapped)   ; 戻り値は stat
; hNamedPipe : HANDLE -> "sptr"
; lpInBuffer : void* optional -> "sptr"
; nInBufferSize : DWORD -> "sptr"
; lpOutBuffer : void* optional, out -> "sptr"
; nOutBufferSize : DWORD -> "sptr"
; lpBytesRead : DWORD* out -> "sptr"
; lpOverlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global TransactNamedPipe "TransactNamedPipe" sptr, sptr, int, sptr, int, var, var
; res = TransactNamedPipe(hNamedPipe, lpInBuffer, nInBufferSize, lpOutBuffer, nOutBufferSize, lpBytesRead, lpOverlapped)
; hNamedPipe : HANDLE -> "sptr"
; lpInBuffer : void* optional -> "sptr"
; nInBufferSize : DWORD -> "int"
; lpOutBuffer : void* optional, out -> "sptr"
; nOutBufferSize : DWORD -> "int"
; lpBytesRead : DWORD* out -> "var"
; lpOverlapped : OVERLAPPED* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL TransactNamedPipe(HANDLE hNamedPipe, void* lpInBuffer, DWORD nInBufferSize, void* lpOutBuffer, DWORD nOutBufferSize, DWORD* lpBytesRead, OVERLAPPED* lpOverlapped)
#uselib "KERNEL32.dll"
#cfunc global TransactNamedPipe "TransactNamedPipe" intptr, intptr, int, intptr, int, var, var
; res = TransactNamedPipe(hNamedPipe, lpInBuffer, nInBufferSize, lpOutBuffer, nOutBufferSize, lpBytesRead, lpOverlapped)
; hNamedPipe : HANDLE -> "intptr"
; lpInBuffer : void* optional -> "intptr"
; nInBufferSize : DWORD -> "int"
; lpOutBuffer : void* optional, out -> "intptr"
; nOutBufferSize : DWORD -> "int"
; lpBytesRead : DWORD* out -> "var"
; lpOverlapped : OVERLAPPED* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procTransactNamedPipe = kernel32.NewProc("TransactNamedPipe")
)

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