CallNamedPipeW

関数

メッセージ型名前付きパイプへ接続し送受信を一括実行する。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

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

パラメーター

名前	型	方向	説明
lpNamedPipeName	LPCWSTR	in	接続して送受信する名前付きパイプの名前(Unicode)を指定する。
lpInBuffer	void*	inoptional	パイプへ書き込むデータを格納したバッファを指定する。
nInBufferSize	DWORD	in	lpInBufferのサイズ(バイト)を指定する。
lpOutBuffer	void*	outoptional	パイプから読み取った応答データを受け取るバッファを指定する。
nOutBufferSize	DWORD	in	lpOutBufferのサイズ(バイト)を指定する。
lpBytesRead	DWORD*	out	lpOutBufferへ読み取られたバイト数を受け取る出力先。
nTimeOut	DWORD	in	パイプが利用可能になるまで待機する時間(ミリ秒)。NMPWAIT_*定数指定可。

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

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

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool CallNamedPipeW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpNamedPipeName,   // LPCWSTR
    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.Unicode, ExactSpelling:=True)>
Public Shared Function CallNamedPipeW(
    <MarshalAs(UnmanagedType.LPWStr)> lpNamedPipeName As String,   ' LPCWSTR
    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 : LPCWSTR
' lpInBuffer : void* optional
' nInBufferSize : DWORD
' lpOutBuffer : void* optional, out
' nOutBufferSize : DWORD
' lpBytesRead : DWORD* out
' nTimeOut : DWORD
Declare PtrSafe Function CallNamedPipeW Lib "kernel32" ( _
    ByVal lpNamedPipeName As LongPtr, _
    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
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CallNamedPipeW = ctypes.windll.kernel32.CallNamedPipeW
CallNamedPipeW.restype = wintypes.BOOL
CallNamedPipeW.argtypes = [
    wintypes.LPCWSTR,  # lpNamedPipeName : LPCWSTR
    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
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CallNamedPipeW = Fiddle::Function.new(
  lib['CallNamedPipeW'],
  [
    Fiddle::TYPE_VOIDP,  # lpNamedPipeName : LPCWSTR
    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)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn CallNamedPipeW(
        lpNamedPipeName: *const u16,  // LPCWSTR
        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.Unicode)]
public static extern bool CallNamedPipeW([MarshalAs(UnmanagedType.LPWStr)] string lpNamedPipeName, IntPtr lpInBuffer, uint nInBufferSize, IntPtr lpOutBuffer, uint nOutBufferSize, out uint lpBytesRead, uint nTimeOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CallNamedPipeW' -Namespace Win32 -PassThru
# $api::CallNamedPipeW(lpNamedPipeName, lpInBuffer, nInBufferSize, lpOutBuffer, nOutBufferSize, lpBytesRead, nTimeOut)

#uselib "KERNEL32.dll"
#func global CallNamedPipeW "CallNamedPipeW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; CallNamedPipeW lpNamedPipeName, lpInBuffer, nInBufferSize, lpOutBuffer, nOutBufferSize, varptr(lpBytesRead), nTimeOut   ; 戻り値は stat
; lpNamedPipeName : LPCWSTR -> "wptr"
; lpInBuffer : void* optional -> "wptr"
; nInBufferSize : DWORD -> "wptr"
; lpOutBuffer : void* optional, out -> "wptr"
; nOutBufferSize : DWORD -> "wptr"
; lpBytesRead : DWORD* out -> "wptr"
; nTimeOut : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global CallNamedPipeW "CallNamedPipeW" wstr, sptr, int, sptr, int, var, int
; res = CallNamedPipeW(lpNamedPipeName, lpInBuffer, nInBufferSize, lpOutBuffer, nOutBufferSize, lpBytesRead, nTimeOut)
; lpNamedPipeName : LPCWSTR -> "wstr"
; lpInBuffer : void* optional -> "sptr"
; nInBufferSize : DWORD -> "int"
; lpOutBuffer : void* optional, out -> "sptr"
; nOutBufferSize : DWORD -> "int"
; lpBytesRead : DWORD* out -> "var"
; nTimeOut : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global CallNamedPipeW "CallNamedPipeW" wstr, sptr, int, sptr, int, sptr, int
; res = CallNamedPipeW(lpNamedPipeName, lpInBuffer, nInBufferSize, lpOutBuffer, nOutBufferSize, varptr(lpBytesRead), nTimeOut)
; lpNamedPipeName : LPCWSTR -> "wstr"
; lpInBuffer : void* optional -> "sptr"
; nInBufferSize : DWORD -> "int"
; lpOutBuffer : void* optional, out -> "sptr"
; nOutBufferSize : DWORD -> "int"
; lpBytesRead : DWORD* out -> "sptr"
; nTimeOut : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL CallNamedPipeW(LPCWSTR lpNamedPipeName, void* lpInBuffer, DWORD nInBufferSize, void* lpOutBuffer, DWORD nOutBufferSize, DWORD* lpBytesRead, DWORD nTimeOut)
#uselib "KERNEL32.dll"
#cfunc global CallNamedPipeW "CallNamedPipeW" wstr, intptr, int, intptr, int, var, int
; res = CallNamedPipeW(lpNamedPipeName, lpInBuffer, nInBufferSize, lpOutBuffer, nOutBufferSize, lpBytesRead, nTimeOut)
; lpNamedPipeName : LPCWSTR -> "wstr"
; lpInBuffer : void* optional -> "intptr"
; nInBufferSize : DWORD -> "int"
; lpOutBuffer : void* optional, out -> "intptr"
; nOutBufferSize : DWORD -> "int"
; lpBytesRead : DWORD* out -> "var"
; nTimeOut : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL CallNamedPipeW(LPCWSTR lpNamedPipeName, void* lpInBuffer, DWORD nInBufferSize, void* lpOutBuffer, DWORD nOutBufferSize, DWORD* lpBytesRead, DWORD nTimeOut)
#uselib "KERNEL32.dll"
#cfunc global CallNamedPipeW "CallNamedPipeW" wstr, intptr, int, intptr, int, intptr, int
; res = CallNamedPipeW(lpNamedPipeName, lpInBuffer, nInBufferSize, lpOutBuffer, nOutBufferSize, varptr(lpBytesRead), nTimeOut)
; lpNamedPipeName : LPCWSTR -> "wstr"
; lpInBuffer : void* optional -> "intptr"
; nInBufferSize : DWORD -> "int"
; lpOutBuffer : void* optional, out -> "intptr"
; nOutBufferSize : DWORD -> "int"
; lpBytesRead : DWORD* out -> "intptr"
; nTimeOut : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCallNamedPipeW = kernel32.NewProc("CallNamedPipeW")
)

// lpNamedPipeName (LPCWSTR), lpInBuffer (void* optional), nInBufferSize (DWORD), lpOutBuffer (void* optional, out), nOutBufferSize (DWORD), lpBytesRead (DWORD* out), nTimeOut (DWORD)
r1, _, err := procCallNamedPipeW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(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 CallNamedPipeW(
  lpNamedPipeName: PWideChar;   // LPCWSTR
  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 'CallNamedPipeW';

result := DllCall("KERNEL32\CallNamedPipeW"
    , "WStr", lpNamedPipeName   ; LPCWSTR
    , "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

●CallNamedPipeW(lpNamedPipeName, lpInBuffer, nInBufferSize, lpOutBuffer, nOutBufferSize, lpBytesRead, nTimeOut) = DLL("KERNEL32.dll", "bool CallNamedPipeW(char*, void*, dword, void*, dword, void*, dword)")
# 呼び出し: CallNamedPipeW(lpNamedPipeName, lpInBuffer, nInBufferSize, lpOutBuffer, nOutBufferSize, lpBytesRead, nTimeOut)
# lpNamedPipeName : LPCWSTR -> "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)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。