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

CreatePipe

関数
読み書き用の匿名パイプを作成する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL CreatePipe(
    HANDLE* hReadPipe,
    HANDLE* hWritePipe,
    SECURITY_ATTRIBUTES* lpPipeAttributes,   // optional
    DWORD nSize
);

パラメーター

名前方向説明
hReadPipeHANDLE*out作成された無名パイプの読み取り側ハンドルを受け取る出力先。
hWritePipeHANDLE*out作成された無名パイプの書き込み側ハンドルを受け取る出力先。
lpPipeAttributesSECURITY_ATTRIBUTES*inoptionalハンドルの継承可否やセキュリティ記述子を指定するSECURITY_ATTRIBUTES。NULLで既定。
nSizeDWORDinパイプバッファに推奨するサイズ(バイト)。0でシステム既定値を使用する。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

CreatePipe = ctypes.windll.kernel32.CreatePipe
CreatePipe.restype = wintypes.BOOL
CreatePipe.argtypes = [
    ctypes.c_void_p,  # hReadPipe : HANDLE* out
    ctypes.c_void_p,  # hWritePipe : HANDLE* out
    ctypes.c_void_p,  # lpPipeAttributes : SECURITY_ATTRIBUTES* optional
    wintypes.DWORD,  # nSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreatePipe = kernel32.NewProc("CreatePipe")
)

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

extern "kernel32" fn CreatePipe(
    hReadPipe: ?*anyopaque, // HANDLE* out
    hWritePipe: ?*anyopaque, // HANDLE* out
    lpPipeAttributes: [*c]SECURITY_ATTRIBUTES, // SECURITY_ATTRIBUTES* optional
    nSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc CreatePipe(
    hReadPipe: pointer,  # HANDLE* out
    hWritePipe: pointer,  # HANDLE* out
    lpPipeAttributes: ptr SECURITY_ATTRIBUTES,  # SECURITY_ATTRIBUTES* optional
    nSize: uint32  # DWORD
): int32 {.importc: "CreatePipe", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int CreatePipe(
    void* hReadPipe,   // HANDLE* out
    void* hWritePipe,   // HANDLE* out
    SECURITY_ATTRIBUTES* lpPipeAttributes,   // SECURITY_ATTRIBUTES* optional
    uint nSize   // DWORD
);
ccall((:CreatePipe, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{SECURITY_ATTRIBUTES}, UInt32),
      hReadPipe, hWritePipe, lpPipeAttributes, nSize)
# hReadPipe : HANDLE* out -> Ptr{Cvoid}
# hWritePipe : HANDLE* out -> Ptr{Cvoid}
# lpPipeAttributes : SECURITY_ATTRIBUTES* optional -> Ptr{SECURITY_ATTRIBUTES}
# nSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CreatePipe(
    void* hReadPipe,
    void* hWritePipe,
    void* lpPipeAttributes,
    uint32_t nSize);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CreatePipe(hReadPipe, hWritePipe, lpPipeAttributes, nSize)
-- hReadPipe : HANDLE* out
-- hWritePipe : HANDLE* out
-- lpPipeAttributes : SECURITY_ATTRIBUTES* optional
-- nSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CreatePipe = lib.func('__stdcall', 'CreatePipe', 'int32_t', ['void *', 'void *', 'void *', 'uint32_t']);
// CreatePipe(hReadPipe, hWritePipe, lpPipeAttributes, nSize)
// hReadPipe : HANDLE* out -> 'void *'
// hWritePipe : HANDLE* out -> 'void *'
// lpPipeAttributes : SECURITY_ATTRIBUTES* optional -> 'void *'
// nSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  CreatePipe: { parameters: ["pointer", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.CreatePipe(hReadPipe, hWritePipe, lpPipeAttributes, nSize)
// hReadPipe : HANDLE* out -> "pointer"
// hWritePipe : HANDLE* out -> "pointer"
// lpPipeAttributes : SECURITY_ATTRIBUTES* optional -> "pointer"
// nSize : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CreatePipe(
    void* hReadPipe,
    void* hWritePipe,
    void* lpPipeAttributes,
    uint32_t nSize);
C, "KERNEL32.dll");
// $ffi->CreatePipe(hReadPipe, hWritePipe, lpPipeAttributes, nSize);
// hReadPipe : HANDLE* out
// hWritePipe : HANDLE* out
// lpPipeAttributes : SECURITY_ATTRIBUTES* optional
// nSize : DWORD
// 構造体/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);
    boolean CreatePipe(
        Pointer hReadPipe,   // HANDLE* out
        Pointer hWritePipe,   // HANDLE* out
        Pointer lpPipeAttributes,   // SECURITY_ATTRIBUTES* optional
        int nSize   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun CreatePipe = CreatePipe(
    hReadPipe : Void*,   # HANDLE* out
    hWritePipe : Void*,   # HANDLE* out
    lpPipeAttributes : SECURITY_ATTRIBUTES*,   # SECURITY_ATTRIBUTES* optional
    nSize : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CreatePipeNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Uint32);
typedef CreatePipeDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, int);
final CreatePipe = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreatePipeNative, CreatePipeDart>('CreatePipe');
// hReadPipe : HANDLE* out -> Pointer<Void>
// hWritePipe : HANDLE* out -> Pointer<Void>
// lpPipeAttributes : SECURITY_ATTRIBUTES* optional -> Pointer<Void>
// nSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreatePipe(
  hReadPipe: Pointer;   // HANDLE* out
  hWritePipe: Pointer;   // HANDLE* out
  lpPipeAttributes: Pointer;   // SECURITY_ATTRIBUTES* optional
  nSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'CreatePipe';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreatePipe"
  c_CreatePipe :: Ptr () -> Ptr () -> Ptr () -> Word32 -> IO CInt
-- hReadPipe : HANDLE* out -> Ptr ()
-- hWritePipe : HANDLE* out -> Ptr ()
-- lpPipeAttributes : SECURITY_ATTRIBUTES* optional -> Ptr ()
-- nSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createpipe =
  foreign "CreatePipe"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hReadPipe : HANDLE* out -> (ptr void) *)
(* hWritePipe : HANDLE* out -> (ptr void) *)
(* lpPipeAttributes : SECURITY_ATTRIBUTES* optional -> (ptr void) *)
(* nSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CreatePipe" create-pipe :convention :stdcall) :int32
  (h-read-pipe :pointer)   ; HANDLE* out
  (h-write-pipe :pointer)   ; HANDLE* out
  (lp-pipe-attributes :pointer)   ; SECURITY_ATTRIBUTES* optional
  (n-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreatePipe = Win32::API::More->new('KERNEL32',
    'BOOL CreatePipe(HANDLE hReadPipe, HANDLE hWritePipe, LPVOID lpPipeAttributes, DWORD nSize)');
# my $ret = $CreatePipe->Call($hReadPipe, $hWritePipe, $lpPipeAttributes, $nSize);
# hReadPipe : HANDLE* out -> HANDLE
# hWritePipe : HANDLE* out -> HANDLE
# lpPipeAttributes : SECURITY_ATTRIBUTES* optional -> LPVOID
# nSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型