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

CallNamedPipeA

関数
名前付きパイプへ接続し送受信を一括実行する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL CallNamedPipeA(
    LPCSTR lpNamedPipeName,
    void* lpInBuffer,   // optional
    DWORD nInBufferSize,
    void* lpOutBuffer,   // optional
    DWORD nOutBufferSize,
    DWORD* lpBytesRead,
    DWORD nTimeOut
);

パラメーター

名前方向
lpNamedPipeNameLPCSTRin
lpInBuffervoid*inoptional
nInBufferSizeDWORDin
lpOutBuffervoid*outoptional
nOutBufferSizeDWORDin
lpBytesReadDWORD*out
nTimeOutDWORDin

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL CallNamedPipeA(
    LPCSTR lpNamedPipeName,
    void* lpInBuffer,   // optional
    DWORD nInBufferSize,
    void* lpOutBuffer,   // optional
    DWORD nOutBufferSize,
    DWORD* lpBytesRead,
    DWORD nTimeOut
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CallNamedPipeA(
    [MarshalAs(UnmanagedType.LPStr)] string lpNamedPipeName,   // LPCSTR
    IntPtr lpInBuffer,   // void* optional
    uint nInBufferSize,   // DWORD
    IntPtr lpOutBuffer,   // void* optional, out
    uint nOutBufferSize,   // DWORD
    out uint lpBytesRead,   // DWORD* out
    uint nTimeOut   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CallNamedPipeA(
    <MarshalAs(UnmanagedType.LPStr)> lpNamedPipeName As String,   ' LPCSTR
    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
    nTimeOut As UInteger   ' DWORD
) As Boolean
End Function
' lpNamedPipeName : LPCSTR
' lpInBuffer : void* optional
' nInBufferSize : DWORD
' lpOutBuffer : void* optional, out
' nOutBufferSize : DWORD
' lpBytesRead : DWORD* out
' nTimeOut : DWORD
Declare PtrSafe Function CallNamedPipeA Lib "kernel32" ( _
    ByVal lpNamedPipeName As String, _
    ByVal lpInBuffer As LongPtr, _
    ByVal nInBufferSize As Long, _
    ByVal lpOutBuffer As LongPtr, _
    ByVal nOutBufferSize As Long, _
    ByRef lpBytesRead As Long, _
    ByVal nTimeOut As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CallNamedPipeA = ctypes.windll.kernel32.CallNamedPipeA
CallNamedPipeA.restype = wintypes.BOOL
CallNamedPipeA.argtypes = [
    wintypes.LPCSTR,  # lpNamedPipeName : LPCSTR
    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
    wintypes.DWORD,  # nTimeOut : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCallNamedPipeA = kernel32.NewProc("CallNamedPipeA")
)

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