CreateNamedPipeA
関数シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
HANDLE CreateNamedPipeA(
LPCSTR lpName,
FILE_FLAGS_AND_ATTRIBUTES dwOpenMode,
NAMED_PIPE_MODE dwPipeMode,
DWORD nMaxInstances,
DWORD nOutBufferSize,
DWORD nInBufferSize,
DWORD nDefaultTimeOut,
SECURITY_ATTRIBUTES* lpSecurityAttributes // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| lpName | LPCSTR | in | 一意のパイプ名。この文字列は次の形式である必要があります。 \\.\pipe\pipename 名前のうち pipename の部分には、円記号 (バックスラッシュ) 以外の任意の文字を使用でき、数字や特殊文字も指定できます。パイプ名の文字列全体は最大 256 文字です。パイプ名では大文字と小文字は区別されません。 | ||||||||||||||||||||||||
| dwOpenMode | FILE_FLAGS_AND_ATTRIBUTES | in | オープンモード。 dwOpenMode に 0 または次の表に示すフラグ以外を指定した場合、この関数は失敗します。 このパラメーターには、次のいずれかのパイプアクセスモードを指定する必要があります。パイプの各インスタンスには同じモードを指定する必要があります。
このパラメーターには、ライトスルーモードとオーバーラップモードを有効にする次のフラグを 1 つ以上含めることもできます。これらのモードは、同じパイプのインスタンスごとに異なっていてもかまいません。
このパラメーターには、次のセキュリティアクセスモードを任意に組み合わせて含めることができます。これらのモードは、同じパイプのインスタンスごとに異なっていてもかまいません。
| ||||||||||||||||||||||||
| dwPipeMode | NAMED_PIPE_MODE | in | パイプモード。 dwPipeMode に 0 または次の表に示すフラグ以外を指定した場合、この関数は失敗します。 次のいずれかの型モードを指定できます。パイプの各インスタンスには同じ型モードを指定する必要があります。
次のいずれかの読み取りモードを指定できます。同じパイプのインスタンスごとに異なる読み取りモードを指定できます。
次のいずれかの待機モードを指定できます。同じパイプのインスタンスごとに異なる待機モードを指定できます。
次のいずれかのリモートクライアントモードを指定できます。同じパイプのインスタンスごとに異なるリモートクライアントモードを指定できます。
| ||||||||||||||||||||||||
| nMaxInstances | DWORD | in | このパイプに対して作成できるインスタンスの最大数。パイプの最初のインスタンスでこの値を指定できます。パイプの他のインスタンスには同じ数を指定する必要があります。指定できる値の範囲は 1 から PIPE_UNLIMITED_INSTANCES (255) までです。 このパラメーターが PIPE_UNLIMITED_INSTANCES の場合、作成できるパイプインスタンスの数は、システムリソースの空き状況によってのみ制限されます。nMaxInstances が PIPE_UNLIMITED_INSTANCES より大きい場合、戻り値は INVALID_HANDLE_VALUE となり、GetLastError は ERROR_INVALID_PARAMETER を返します。 | ||||||||||||||||||||||||
| nOutBufferSize | DWORD | in | 出力バッファー用に確保するバイト数。名前付きパイプのバッファーサイズの決め方については、後述の「解説」セクションを参照してください。 | ||||||||||||||||||||||||
| nInBufferSize | DWORD | in | 入力バッファー用に確保するバイト数。名前付きパイプのバッファーサイズの決め方については、後述の「解説」セクションを参照してください。 | ||||||||||||||||||||||||
| nDefaultTimeOut | DWORD | in | WaitNamedPipe 関数が NMPWAIT_USE_DEFAULT_WAIT を指定した場合に使用される、既定のタイムアウト値 (ミリ秒単位)。名前付きパイプの各インスタンスには同じ値を指定する必要があります。 値が 0 の場合、既定のタイムアウトは 50 ミリ秒になります。 | ||||||||||||||||||||||||
| lpSecurityAttributes | SECURITY_ATTRIBUTES* | inoptional | 新しい名前付きパイプのセキュリティ記述子を指定し、返されるハンドルを子プロセスが継承できるかどうかを決定する SECURITY_ATTRIBUTES 構造体へのポインター。lpSecurityAttributes が NULL の場合、名前付きパイプには既定のセキュリティ記述子が設定され、ハンドルは継承できません。名前付きパイプの既定のセキュリティ記述子に含まれる ACL は、LocalSystem アカウント、Administrators、および作成者所有者にフルコントロールを付与します。また、Everyone グループのメンバーと anonymous アカウントには読み取りアクセスを付与します。 |
戻り値の型: HANDLE
公式ドキュメント
CreateNamedPipeA (ANSI) 関数 (winbase.h) は、名前付きパイプのインスタンスを作成し、以降のパイプ操作で使用するハンドルを返します。
戻り値
関数が成功した場合、戻り値は名前付きパイプインスタンスのサーバー側へのハンドルです。
関数が失敗した場合、戻り値は INVALID_HANDLE_VALUE です。詳細なエラー情報を取得するには、 GetLastError を呼び出します。
解説(Remarks)
CreateNamedPipe を使用して名前付きパイプのインスタンスを作成するには、ユーザーが名前付きパイプオブジェクトに対する FILE_CREATE_PIPE_INSTANCE アクセス権を持っている必要があります。新しい名前付きパイプを作成する場合、セキュリティ属性パラメーターのアクセス制御リスト (ACL) が、その名前付きパイプの随意アクセス制御を定義します。
名前付きパイプのすべてのインスタンスには、同じパイプの型 (バイト型またはメッセージ型)、パイプアクセス (双方向、受信、送信)、インスタンス数、およびタイムアウト値を指定する必要があります。異なる値が使用された場合、この関数は失敗し、GetLastError は ERROR_ACCESS_DENIED を返します。
クライアントプロセスは、CreateFile 関数または CallNamedPipe 関数を使用して名前付きパイプに接続します。名前付きパイプのクライアント側は、サーバー側がメッセージモードであっても、最初はバイトモードで開始されます。データ受信時の問題を避けるため、クライアント側もメッセージモードに設定してください。パイプのモードを変更するには、パイプクライアントが GENERIC_READ と FILE_WRITE_ATTRIBUTES のアクセス権で読み取り専用のパイプを開く必要があります。
パイプサーバーは、パイプクライアントが開始するまで、ブロッキングの読み取り操作を実行すべきではありません。実行すると競合状態が発生する可能性があります。これは通常、C ランタイムなどの初期化コードが、継承されたハンドルをロックして調べる必要がある場合に発生します。
名前付きパイプが作成されるたびに、システムは、カーネルが使用する物理メモリである非ページプールを使用して、受信側または送信側 (あるいはその両方) のバッファーを作成します。作成できるパイプインスタンスの数 (およびスレッドやプロセスなどのオブジェクトの数) は、利用可能な非ページプールによって制限されます。各読み取り要求または書き込み要求には、読み取りデータまたは書き込みデータ用のバッファー領域に加えて、内部データ構造体用の領域が必要になります。
入力バッファーと出力バッファーのサイズは推奨値です。名前付きパイプの各端に実際に確保されるバッファーサイズは、システムの既定値、システムの最小値または最大値、あるいは指定されたサイズを次の割り当て境界に切り上げた値のいずれかになります。指定するバッファーサイズは、プロセスが非ページプールを使い果たさない程度に小さく、かつ一般的な要求に対応できる程度に大きくする必要があります。
パイプへの書き込み操作が発生するたびに、システムはまず、パイプ書き込みクォータに対してメモリを課金しようとします。残りのパイプ書き込みクォータが要求を満たすのに十分であれば、書き込み操作は直ちに完了します。残りのパイプ書き込みクォータが要求を満たすには小さすぎる場合、システムは、プロセス用に予約された非ページプールを使用してバッファーを拡張し、データを格納しようとします。書き込み操作は、追加のバッファークォータを解放できるようにデータがパイプから読み取られるまでブロックされます。したがって、指定したバッファーサイズが小さすぎる場合、システムは必要に応じてバッファーを拡張しますが、その代わりに操作がブロックされるという欠点があります。操作がオーバーラップの場合はシステムスレッドがブロックされ、そうでない場合はアプリケーションのスレッドがブロックされます。
名前付きパイプが使用しているリソースを解放するため、アプリケーションはハンドルが不要になったら必ず閉じる必要があります。これは、CloseHandle 関数を呼び出すか、インスタンスのハンドルに関連付けられたプロセスが終了することで行われます。名前付きパイプのインスタンスには、複数のハンドルが関連付けられている場合がある点に注意してください。名前付きパイプのインスタンスは、そのインスタンスに対する最後のハンドルが閉じられたときに必ず削除されます。
Windows 10 バージョン 1709: パイプはアプリコンテナー内でのみサポートされます。つまり、同じアプリの一部である UWP プロセスから別の UWP プロセスへの通信のみがサポートされます。また、名前付きパイプのパイプ名には \\.\pipe\LOCAL\ という構文を使用する必要があります。
例
例については、 マルチスレッドのパイプサーバー を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
HANDLE CreateNamedPipeA(
LPCSTR lpName,
FILE_FLAGS_AND_ATTRIBUTES dwOpenMode,
NAMED_PIPE_MODE dwPipeMode,
DWORD nMaxInstances,
DWORD nOutBufferSize,
DWORD nInBufferSize,
DWORD nDefaultTimeOut,
SECURITY_ATTRIBUTES* lpSecurityAttributes // optional
);[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateNamedPipeA(
[MarshalAs(UnmanagedType.LPStr)] string lpName, // LPCSTR
uint dwOpenMode, // FILE_FLAGS_AND_ATTRIBUTES
uint dwPipeMode, // NAMED_PIPE_MODE
uint nMaxInstances, // DWORD
uint nOutBufferSize, // DWORD
uint nInBufferSize, // DWORD
uint nDefaultTimeOut, // DWORD
IntPtr lpSecurityAttributes // SECURITY_ATTRIBUTES* optional
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateNamedPipeA(
<MarshalAs(UnmanagedType.LPStr)> lpName As String, ' LPCSTR
dwOpenMode As UInteger, ' FILE_FLAGS_AND_ATTRIBUTES
dwPipeMode As UInteger, ' NAMED_PIPE_MODE
nMaxInstances As UInteger, ' DWORD
nOutBufferSize As UInteger, ' DWORD
nInBufferSize As UInteger, ' DWORD
nDefaultTimeOut As UInteger, ' DWORD
lpSecurityAttributes As IntPtr ' SECURITY_ATTRIBUTES* optional
) As IntPtr
End Function' lpName : LPCSTR
' dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES
' dwPipeMode : NAMED_PIPE_MODE
' nMaxInstances : DWORD
' nOutBufferSize : DWORD
' nInBufferSize : DWORD
' nDefaultTimeOut : DWORD
' lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
Declare PtrSafe Function CreateNamedPipeA Lib "kernel32" ( _
ByVal lpName As String, _
ByVal dwOpenMode As Long, _
ByVal dwPipeMode As Long, _
ByVal nMaxInstances As Long, _
ByVal nOutBufferSize As Long, _
ByVal nInBufferSize As Long, _
ByVal nDefaultTimeOut As Long, _
ByVal lpSecurityAttributes As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
CreateNamedPipeA = ctypes.windll.kernel32.CreateNamedPipeA
CreateNamedPipeA.restype = ctypes.c_void_p
CreateNamedPipeA.argtypes = [
wintypes.LPCSTR, # lpName : LPCSTR
wintypes.DWORD, # dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES
wintypes.DWORD, # dwPipeMode : NAMED_PIPE_MODE
wintypes.DWORD, # nMaxInstances : DWORD
wintypes.DWORD, # nOutBufferSize : DWORD
wintypes.DWORD, # nInBufferSize : DWORD
wintypes.DWORD, # nDefaultTimeOut : DWORD
ctypes.c_void_p, # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
CreateNamedPipeA = Fiddle::Function.new(
lib['CreateNamedPipeA'],
[
Fiddle::TYPE_VOIDP, # lpName : LPCSTR
-Fiddle::TYPE_INT, # dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES
-Fiddle::TYPE_INT, # dwPipeMode : NAMED_PIPE_MODE
-Fiddle::TYPE_INT, # nMaxInstances : DWORD
-Fiddle::TYPE_INT, # nOutBufferSize : DWORD
-Fiddle::TYPE_INT, # nInBufferSize : DWORD
-Fiddle::TYPE_INT, # nDefaultTimeOut : DWORD
Fiddle::TYPE_VOIDP, # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
],
Fiddle::TYPE_VOIDP)#[link(name = "kernel32")]
extern "system" {
fn CreateNamedPipeA(
lpName: *const u8, // LPCSTR
dwOpenMode: u32, // FILE_FLAGS_AND_ATTRIBUTES
dwPipeMode: u32, // NAMED_PIPE_MODE
nMaxInstances: u32, // DWORD
nOutBufferSize: u32, // DWORD
nInBufferSize: u32, // DWORD
nDefaultTimeOut: u32, // DWORD
lpSecurityAttributes: *mut SECURITY_ATTRIBUTES // SECURITY_ATTRIBUTES* optional
) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr CreateNamedPipeA([MarshalAs(UnmanagedType.LPStr)] string lpName, uint dwOpenMode, uint dwPipeMode, uint nMaxInstances, uint nOutBufferSize, uint nInBufferSize, uint nDefaultTimeOut, IntPtr lpSecurityAttributes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateNamedPipeA' -Namespace Win32 -PassThru
# $api::CreateNamedPipeA(lpName, dwOpenMode, dwPipeMode, nMaxInstances, nOutBufferSize, nInBufferSize, nDefaultTimeOut, lpSecurityAttributes)#uselib "KERNEL32.dll"
#func global CreateNamedPipeA "CreateNamedPipeA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CreateNamedPipeA lpName, dwOpenMode, dwPipeMode, nMaxInstances, nOutBufferSize, nInBufferSize, nDefaultTimeOut, varptr(lpSecurityAttributes) ; 戻り値は stat
; lpName : LPCSTR -> "sptr"
; dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES -> "sptr"
; dwPipeMode : NAMED_PIPE_MODE -> "sptr"
; nMaxInstances : DWORD -> "sptr"
; nOutBufferSize : DWORD -> "sptr"
; nInBufferSize : DWORD -> "sptr"
; nDefaultTimeOut : DWORD -> "sptr"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll" #cfunc global CreateNamedPipeA "CreateNamedPipeA" str, int, int, int, int, int, int, var ; res = CreateNamedPipeA(lpName, dwOpenMode, dwPipeMode, nMaxInstances, nOutBufferSize, nInBufferSize, nDefaultTimeOut, lpSecurityAttributes) ; lpName : LPCSTR -> "str" ; dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES -> "int" ; dwPipeMode : NAMED_PIPE_MODE -> "int" ; nMaxInstances : DWORD -> "int" ; nOutBufferSize : DWORD -> "int" ; nInBufferSize : DWORD -> "int" ; nDefaultTimeOut : DWORD -> "int" ; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global CreateNamedPipeA "CreateNamedPipeA" str, int, int, int, int, int, int, sptr ; res = CreateNamedPipeA(lpName, dwOpenMode, dwPipeMode, nMaxInstances, nOutBufferSize, nInBufferSize, nDefaultTimeOut, varptr(lpSecurityAttributes)) ; lpName : LPCSTR -> "str" ; dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES -> "int" ; dwPipeMode : NAMED_PIPE_MODE -> "int" ; nMaxInstances : DWORD -> "int" ; nOutBufferSize : DWORD -> "int" ; nInBufferSize : DWORD -> "int" ; nDefaultTimeOut : DWORD -> "int" ; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; HANDLE CreateNamedPipeA(LPCSTR lpName, FILE_FLAGS_AND_ATTRIBUTES dwOpenMode, NAMED_PIPE_MODE dwPipeMode, DWORD nMaxInstances, DWORD nOutBufferSize, DWORD nInBufferSize, DWORD nDefaultTimeOut, SECURITY_ATTRIBUTES* lpSecurityAttributes) #uselib "KERNEL32.dll" #cfunc global CreateNamedPipeA "CreateNamedPipeA" str, int, int, int, int, int, int, var ; res = CreateNamedPipeA(lpName, dwOpenMode, dwPipeMode, nMaxInstances, nOutBufferSize, nInBufferSize, nDefaultTimeOut, lpSecurityAttributes) ; lpName : LPCSTR -> "str" ; dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES -> "int" ; dwPipeMode : NAMED_PIPE_MODE -> "int" ; nMaxInstances : DWORD -> "int" ; nOutBufferSize : DWORD -> "int" ; nInBufferSize : DWORD -> "int" ; nDefaultTimeOut : DWORD -> "int" ; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HANDLE CreateNamedPipeA(LPCSTR lpName, FILE_FLAGS_AND_ATTRIBUTES dwOpenMode, NAMED_PIPE_MODE dwPipeMode, DWORD nMaxInstances, DWORD nOutBufferSize, DWORD nInBufferSize, DWORD nDefaultTimeOut, SECURITY_ATTRIBUTES* lpSecurityAttributes) #uselib "KERNEL32.dll" #cfunc global CreateNamedPipeA "CreateNamedPipeA" str, int, int, int, int, int, int, intptr ; res = CreateNamedPipeA(lpName, dwOpenMode, dwPipeMode, nMaxInstances, nOutBufferSize, nInBufferSize, nDefaultTimeOut, varptr(lpSecurityAttributes)) ; lpName : LPCSTR -> "str" ; dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES -> "int" ; dwPipeMode : NAMED_PIPE_MODE -> "int" ; nMaxInstances : DWORD -> "int" ; nOutBufferSize : DWORD -> "int" ; nInBufferSize : DWORD -> "int" ; nDefaultTimeOut : DWORD -> "int" ; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procCreateNamedPipeA = kernel32.NewProc("CreateNamedPipeA")
)
// lpName (LPCSTR), dwOpenMode (FILE_FLAGS_AND_ATTRIBUTES), dwPipeMode (NAMED_PIPE_MODE), nMaxInstances (DWORD), nOutBufferSize (DWORD), nInBufferSize (DWORD), nDefaultTimeOut (DWORD), lpSecurityAttributes (SECURITY_ATTRIBUTES* optional)
r1, _, err := procCreateNamedPipeA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpName))),
uintptr(dwOpenMode),
uintptr(dwPipeMode),
uintptr(nMaxInstances),
uintptr(nOutBufferSize),
uintptr(nInBufferSize),
uintptr(nDefaultTimeOut),
uintptr(lpSecurityAttributes),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HANDLEfunction CreateNamedPipeA(
lpName: PAnsiChar; // LPCSTR
dwOpenMode: DWORD; // FILE_FLAGS_AND_ATTRIBUTES
dwPipeMode: DWORD; // NAMED_PIPE_MODE
nMaxInstances: DWORD; // DWORD
nOutBufferSize: DWORD; // DWORD
nInBufferSize: DWORD; // DWORD
nDefaultTimeOut: DWORD; // DWORD
lpSecurityAttributes: Pointer // SECURITY_ATTRIBUTES* optional
): THandle; stdcall;
external 'KERNEL32.dll' name 'CreateNamedPipeA';result := DllCall("KERNEL32\CreateNamedPipeA"
, "AStr", lpName ; LPCSTR
, "UInt", dwOpenMode ; FILE_FLAGS_AND_ATTRIBUTES
, "UInt", dwPipeMode ; NAMED_PIPE_MODE
, "UInt", nMaxInstances ; DWORD
, "UInt", nOutBufferSize ; DWORD
, "UInt", nInBufferSize ; DWORD
, "UInt", nDefaultTimeOut ; DWORD
, "Ptr", lpSecurityAttributes ; SECURITY_ATTRIBUTES* optional
, "Ptr") ; return: HANDLE●CreateNamedPipeA(lpName, dwOpenMode, dwPipeMode, nMaxInstances, nOutBufferSize, nInBufferSize, nDefaultTimeOut, lpSecurityAttributes) = DLL("KERNEL32.dll", "void* CreateNamedPipeA(char*, dword, dword, dword, dword, dword, dword, void*)")
# 呼び出し: CreateNamedPipeA(lpName, dwOpenMode, dwPipeMode, nMaxInstances, nOutBufferSize, nInBufferSize, nDefaultTimeOut, lpSecurityAttributes)
# lpName : LPCSTR -> "char*"
# dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES -> "dword"
# dwPipeMode : NAMED_PIPE_MODE -> "dword"
# nMaxInstances : DWORD -> "dword"
# nOutBufferSize : DWORD -> "dword"
# nInBufferSize : DWORD -> "dword"
# nDefaultTimeOut : DWORD -> "dword"
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn CreateNamedPipeA(
lpName: [*c]const u8, // LPCSTR
dwOpenMode: u32, // FILE_FLAGS_AND_ATTRIBUTES
dwPipeMode: u32, // NAMED_PIPE_MODE
nMaxInstances: u32, // DWORD
nOutBufferSize: u32, // DWORD
nInBufferSize: u32, // DWORD
nDefaultTimeOut: u32, // DWORD
lpSecurityAttributes: [*c]SECURITY_ATTRIBUTES // SECURITY_ATTRIBUTES* optional
) callconv(std.os.windows.WINAPI) ?*anyopaque;proc CreateNamedPipeA(
lpName: cstring, # LPCSTR
dwOpenMode: uint32, # FILE_FLAGS_AND_ATTRIBUTES
dwPipeMode: uint32, # NAMED_PIPE_MODE
nMaxInstances: uint32, # DWORD
nOutBufferSize: uint32, # DWORD
nInBufferSize: uint32, # DWORD
nDefaultTimeOut: uint32, # DWORD
lpSecurityAttributes: ptr SECURITY_ATTRIBUTES # SECURITY_ATTRIBUTES* optional
): pointer {.importc: "CreateNamedPipeA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
void* CreateNamedPipeA(
const(char)* lpName, // LPCSTR
uint dwOpenMode, // FILE_FLAGS_AND_ATTRIBUTES
uint dwPipeMode, // NAMED_PIPE_MODE
uint nMaxInstances, // DWORD
uint nOutBufferSize, // DWORD
uint nInBufferSize, // DWORD
uint nDefaultTimeOut, // DWORD
SECURITY_ATTRIBUTES* lpSecurityAttributes // SECURITY_ATTRIBUTES* optional
);ccall((:CreateNamedPipeA, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
(Cstring, UInt32, UInt32, UInt32, UInt32, UInt32, UInt32, Ptr{SECURITY_ATTRIBUTES}),
lpName, dwOpenMode, dwPipeMode, nMaxInstances, nOutBufferSize, nInBufferSize, nDefaultTimeOut, lpSecurityAttributes)
# lpName : LPCSTR -> Cstring
# dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES -> UInt32
# dwPipeMode : NAMED_PIPE_MODE -> UInt32
# nMaxInstances : DWORD -> UInt32
# nOutBufferSize : DWORD -> UInt32
# nInBufferSize : DWORD -> UInt32
# nDefaultTimeOut : DWORD -> UInt32
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Ptr{SECURITY_ATTRIBUTES}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
void* CreateNamedPipeA(
const char* lpName,
uint32_t dwOpenMode,
uint32_t dwPipeMode,
uint32_t nMaxInstances,
uint32_t nOutBufferSize,
uint32_t nInBufferSize,
uint32_t nDefaultTimeOut,
void* lpSecurityAttributes);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CreateNamedPipeA(lpName, dwOpenMode, dwPipeMode, nMaxInstances, nOutBufferSize, nInBufferSize, nDefaultTimeOut, lpSecurityAttributes)
-- lpName : LPCSTR
-- dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES
-- dwPipeMode : NAMED_PIPE_MODE
-- nMaxInstances : DWORD
-- nOutBufferSize : DWORD
-- nInBufferSize : DWORD
-- nDefaultTimeOut : DWORD
-- lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CreateNamedPipeA = lib.func('__stdcall', 'CreateNamedPipeA', 'void *', ['str', 'uint32_t', 'uint32_t', 'uint32_t', 'uint32_t', 'uint32_t', 'uint32_t', 'void *']);
// CreateNamedPipeA(lpName, dwOpenMode, dwPipeMode, nMaxInstances, nOutBufferSize, nInBufferSize, nDefaultTimeOut, lpSecurityAttributes)
// lpName : LPCSTR -> 'str'
// dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES -> 'uint32_t'
// dwPipeMode : NAMED_PIPE_MODE -> 'uint32_t'
// nMaxInstances : DWORD -> 'uint32_t'
// nOutBufferSize : DWORD -> 'uint32_t'
// nInBufferSize : DWORD -> 'uint32_t'
// nDefaultTimeOut : DWORD -> 'uint32_t'
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
CreateNamedPipeA: { parameters: ["buffer", "u32", "u32", "u32", "u32", "u32", "u32", "pointer"], result: "pointer" },
});
// lib.symbols.CreateNamedPipeA(lpName, dwOpenMode, dwPipeMode, nMaxInstances, nOutBufferSize, nInBufferSize, nDefaultTimeOut, lpSecurityAttributes)
// lpName : LPCSTR -> "buffer"
// dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES -> "u32"
// dwPipeMode : NAMED_PIPE_MODE -> "u32"
// nMaxInstances : DWORD -> "u32"
// nOutBufferSize : DWORD -> "u32"
// nInBufferSize : DWORD -> "u32"
// nDefaultTimeOut : DWORD -> "u32"
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void* CreateNamedPipeA(
const char* lpName,
uint32_t dwOpenMode,
uint32_t dwPipeMode,
uint32_t nMaxInstances,
uint32_t nOutBufferSize,
uint32_t nInBufferSize,
uint32_t nDefaultTimeOut,
void* lpSecurityAttributes);
C, "KERNEL32.dll");
// $ffi->CreateNamedPipeA(lpName, dwOpenMode, dwPipeMode, nMaxInstances, nOutBufferSize, nInBufferSize, nDefaultTimeOut, lpSecurityAttributes);
// lpName : LPCSTR
// dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES
// dwPipeMode : NAMED_PIPE_MODE
// nMaxInstances : DWORD
// nOutBufferSize : DWORD
// nInBufferSize : DWORD
// nDefaultTimeOut : DWORD
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Kernel32 extends StdCallLibrary {
Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.ASCII_OPTIONS);
Pointer CreateNamedPipeA(
String lpName, // LPCSTR
int dwOpenMode, // FILE_FLAGS_AND_ATTRIBUTES
int dwPipeMode, // NAMED_PIPE_MODE
int nMaxInstances, // DWORD
int nOutBufferSize, // DWORD
int nInBufferSize, // DWORD
int nDefaultTimeOut, // DWORD
Pointer lpSecurityAttributes // SECURITY_ATTRIBUTES* optional
);
}@[Link("kernel32")]
lib LibKERNEL32
fun CreateNamedPipeA = CreateNamedPipeA(
lpName : UInt8*, # LPCSTR
dwOpenMode : UInt32, # FILE_FLAGS_AND_ATTRIBUTES
dwPipeMode : UInt32, # NAMED_PIPE_MODE
nMaxInstances : UInt32, # DWORD
nOutBufferSize : UInt32, # DWORD
nInBufferSize : UInt32, # DWORD
nDefaultTimeOut : UInt32, # DWORD
lpSecurityAttributes : SECURITY_ATTRIBUTES* # SECURITY_ATTRIBUTES* optional
) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef CreateNamedPipeANative = Pointer<Void> Function(Pointer<Utf8>, Uint32, Uint32, Uint32, Uint32, Uint32, Uint32, Pointer<Void>);
typedef CreateNamedPipeADart = Pointer<Void> Function(Pointer<Utf8>, int, int, int, int, int, int, Pointer<Void>);
final CreateNamedPipeA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<CreateNamedPipeANative, CreateNamedPipeADart>('CreateNamedPipeA');
// lpName : LPCSTR -> Pointer<Utf8>
// dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES -> Uint32
// dwPipeMode : NAMED_PIPE_MODE -> Uint32
// nMaxInstances : DWORD -> Uint32
// nOutBufferSize : DWORD -> Uint32
// nInBufferSize : DWORD -> Uint32
// nDefaultTimeOut : DWORD -> Uint32
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CreateNamedPipeA(
lpName: PAnsiChar; // LPCSTR
dwOpenMode: DWORD; // FILE_FLAGS_AND_ATTRIBUTES
dwPipeMode: DWORD; // NAMED_PIPE_MODE
nMaxInstances: DWORD; // DWORD
nOutBufferSize: DWORD; // DWORD
nInBufferSize: DWORD; // DWORD
nDefaultTimeOut: DWORD; // DWORD
lpSecurityAttributes: Pointer // SECURITY_ATTRIBUTES* optional
): THandle; stdcall;
external 'KERNEL32.dll' name 'CreateNamedPipeA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CreateNamedPipeA"
c_CreateNamedPipeA :: CString -> Word32 -> Word32 -> Word32 -> Word32 -> Word32 -> Word32 -> Ptr () -> IO (Ptr ())
-- lpName : LPCSTR -> CString
-- dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES -> Word32
-- dwPipeMode : NAMED_PIPE_MODE -> Word32
-- nMaxInstances : DWORD -> Word32
-- nOutBufferSize : DWORD -> Word32
-- nInBufferSize : DWORD -> Word32
-- nDefaultTimeOut : DWORD -> Word32
-- lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let createnamedpipea =
foreign "CreateNamedPipeA"
(string @-> uint32_t @-> uint32_t @-> uint32_t @-> uint32_t @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning (ptr void))
(* lpName : LPCSTR -> string *)
(* dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES -> uint32_t *)
(* dwPipeMode : NAMED_PIPE_MODE -> uint32_t *)
(* nMaxInstances : DWORD -> uint32_t *)
(* nOutBufferSize : DWORD -> uint32_t *)
(* nInBufferSize : DWORD -> uint32_t *)
(* nDefaultTimeOut : DWORD -> uint32_t *)
(* lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("CreateNamedPipeA" create-named-pipe-a :convention :stdcall) :pointer
(lp-name :string) ; LPCSTR
(dw-open-mode :uint32) ; FILE_FLAGS_AND_ATTRIBUTES
(dw-pipe-mode :uint32) ; NAMED_PIPE_MODE
(n-max-instances :uint32) ; DWORD
(n-out-buffer-size :uint32) ; DWORD
(n-in-buffer-size :uint32) ; DWORD
(n-default-time-out :uint32) ; DWORD
(lp-security-attributes :pointer)) ; SECURITY_ATTRIBUTES* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CreateNamedPipeA = Win32::API::More->new('KERNEL32',
'HANDLE CreateNamedPipeA(LPCSTR lpName, DWORD dwOpenMode, DWORD dwPipeMode, DWORD nMaxInstances, DWORD nOutBufferSize, DWORD nInBufferSize, DWORD nDefaultTimeOut, LPVOID lpSecurityAttributes)');
# my $ret = $CreateNamedPipeA->Call($lpName, $dwOpenMode, $dwPipeMode, $nMaxInstances, $nOutBufferSize, $nInBufferSize, $nDefaultTimeOut, $lpSecurityAttributes);
# lpName : LPCSTR -> LPCSTR
# dwOpenMode : FILE_FLAGS_AND_ATTRIBUTES -> DWORD
# dwPipeMode : NAMED_PIPE_MODE -> DWORD
# nMaxInstances : DWORD -> DWORD
# nOutBufferSize : DWORD -> DWORD
# nInBufferSize : DWORD -> DWORD
# nDefaultTimeOut : DWORD -> DWORD
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f CreateNamedPipeW (Unicode版) — 名前付きパイプのインスタンスを作成する。
- f ConnectNamedPipe — 名前付きパイプサーバーがクライアント接続を待ち受ける。
- f CreateFileA — ファイルやデバイスを作成または開いてハンドルを返す(ANSI版)。
- f ReadFile — ファイルやデバイスからデータを読み込む。
- f ReadFileEx — 完了ルーチンを使い非同期でファイルを読み込む。
- f TransactNamedPipe — 名前付きパイプへの書き込みと読み取りを一括実行する。
- f WaitNamedPipeA — 名前付きパイプが利用可能になるまで待機する(ANSI版)。
- f WriteFile — ファイルやデバイスにデータを書き込む。
- f WriteFileEx — 完了ルーチンを使い非同期でファイルに書き込む。