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

CreatePseudoConsole

関数
指定サイズと入出力ハンドルで擬似コンソールを作成する。
DLLKERNEL32.dll呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HRESULT CreatePseudoConsole(
    COORD size,
    HANDLE hInput,
    HANDLE hOutput,
    DWORD dwFlags,
    HPCON* phPC
);

パラメーター

名前型方向説明
sizeCOORDin疑似コンソールの初期サイズ(文字単位の幅・高さ)を示すCOORD値。
hInputHANDLEin疑似コンソールが入力を読み取るパイプ等のハンドル。
hOutputHANDLEin疑似コンソールが出力を書き込むパイプ等のハンドル。
dwFlagsDWORDin疑似コンソールの動作を制御するフラグ。PSEUDOCONSOLE_INHERIT_CURSOR等。
phPCHPCON*out生成された疑似コンソールハンドル(HPCON)を受け取る出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT CreatePseudoConsole(
    COORD size,
    HANDLE hInput,
    HANDLE hOutput,
    DWORD dwFlags,
    HPCON* phPC
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern int CreatePseudoConsole(
    COORD size,   // COORD
    IntPtr hInput,   // HANDLE
    IntPtr hOutput,   // HANDLE
    uint dwFlags,   // DWORD
    out IntPtr phPC   // HPCON* out
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function CreatePseudoConsole(
    size As COORD,   ' COORD
    hInput As IntPtr,   ' HANDLE
    hOutput As IntPtr,   ' HANDLE
    dwFlags As UInteger,   ' DWORD
    <Out> ByRef phPC As IntPtr   ' HPCON* out
) As Integer
End Function
' size : COORD
' hInput : HANDLE
' hOutput : HANDLE
' dwFlags : DWORD
' phPC : HPCON* out
Declare PtrSafe Function CreatePseudoConsole Lib "kernel32" ( _
    ByVal size As LongPtr, _
    ByVal hInput As LongPtr, _
    ByVal hOutput As LongPtr, _
    ByVal dwFlags As Long, _
    ByRef phPC As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreatePseudoConsole = ctypes.windll.kernel32.CreatePseudoConsole
CreatePseudoConsole.restype = ctypes.c_int
CreatePseudoConsole.argtypes = [
    COORD,  # size : COORD
    wintypes.HANDLE,  # hInput : HANDLE
    wintypes.HANDLE,  # hOutput : HANDLE
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # phPC : HPCON* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreatePseudoConsole = Fiddle::Function.new(
  lib['CreatePseudoConsole'],
  [
    Fiddle::TYPE_VOIDP,  # size : COORD
    Fiddle::TYPE_VOIDP,  # hInput : HANDLE
    Fiddle::TYPE_VOIDP,  # hOutput : HANDLE
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # phPC : HPCON* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn CreatePseudoConsole(
        size: COORD,  // COORD
        hInput: *mut core::ffi::c_void,  // HANDLE
        hOutput: *mut core::ffi::c_void,  // HANDLE
        dwFlags: u32,  // DWORD
        phPC: *mut isize  // HPCON* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern int CreatePseudoConsole(COORD size, IntPtr hInput, IntPtr hOutput, uint dwFlags, out IntPtr phPC);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreatePseudoConsole' -Namespace Win32 -PassThru
# $api::CreatePseudoConsole(size, hInput, hOutput, dwFlags, phPC)
#uselib "KERNEL32.dll"
#func global CreatePseudoConsole "CreatePseudoConsole" sptr, sptr, sptr, sptr, sptr
; CreatePseudoConsole size, hInput, hOutput, dwFlags, varptr(phPC)   ; 戻り値は stat
; size : COORD -> "sptr"
; hInput : HANDLE -> "sptr"
; hOutput : HANDLE -> "sptr"
; dwFlags : DWORD -> "sptr"
; phPC : HPCON* out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "KERNEL32.dll"
#cfunc global CreatePseudoConsole "CreatePseudoConsole" int, sptr, sptr, int, var
; res = CreatePseudoConsole(size, hInput, hOutput, dwFlags, phPC)
; size : COORD -> "int"
; hInput : HANDLE -> "sptr"
; hOutput : HANDLE -> "sptr"
; dwFlags : DWORD -> "int"
; phPC : HPCON* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; HRESULT CreatePseudoConsole(COORD size, HANDLE hInput, HANDLE hOutput, DWORD dwFlags, HPCON* phPC)
#uselib "KERNEL32.dll"
#cfunc global CreatePseudoConsole "CreatePseudoConsole" int, intptr, intptr, int, var
; res = CreatePseudoConsole(size, hInput, hOutput, dwFlags, phPC)
; size : COORD -> "int"
; hInput : HANDLE -> "intptr"
; hOutput : HANDLE -> "intptr"
; dwFlags : DWORD -> "int"
; phPC : HPCON* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreatePseudoConsole = kernel32.NewProc("CreatePseudoConsole")
)

// size (COORD), hInput (HANDLE), hOutput (HANDLE), dwFlags (DWORD), phPC (HPCON* out)
r1, _, err := procCreatePseudoConsole.Call(
	uintptr(size),
	uintptr(hInput),
	uintptr(hOutput),
	uintptr(dwFlags),
	uintptr(phPC),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function CreatePseudoConsole(
  size: COORD;   // COORD
  hInput: THandle;   // HANDLE
  hOutput: THandle;   // HANDLE
  dwFlags: DWORD;   // DWORD
  phPC: Pointer   // HPCON* out
): Integer; stdcall;
  external 'KERNEL32.dll' name 'CreatePseudoConsole';
result := DllCall("KERNEL32\CreatePseudoConsole"
    , "Ptr", size   ; COORD
    , "Ptr", hInput   ; HANDLE
    , "Ptr", hOutput   ; HANDLE
    , "UInt", dwFlags   ; DWORD
    , "Ptr", phPC   ; HPCON* out
    , "Int")   ; return: HRESULT
●CreatePseudoConsole(size, hInput, hOutput, dwFlags, phPC) = DLL("KERNEL32.dll", "int CreatePseudoConsole(void*, void*, void*, dword, void*)")
# 呼び出し: CreatePseudoConsole(size, hInput, hOutput, dwFlags, phPC)
# size : COORD -> "void*"
# hInput : HANDLE -> "void*"
# hOutput : HANDLE -> "void*"
# dwFlags : DWORD -> "dword"
# phPC : HPCON* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef CreatePseudoConsoleNative = Int32 Function(COORD, Pointer<Void>, Pointer<Void>, Uint32, Pointer<IntPtr>);
typedef CreatePseudoConsoleDart = int Function(int, Pointer<Void>, Pointer<Void>, int, Pointer<IntPtr>);
final CreatePseudoConsole = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreatePseudoConsoleNative, CreatePseudoConsoleDart>('CreatePseudoConsole');
// size : COORD -> COORD
// hInput : HANDLE -> Pointer<Void>
// hOutput : HANDLE -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// phPC : HPCON* out -> Pointer<IntPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreatePseudoConsole(
  size: COORD;   // COORD
  hInput: THandle;   // HANDLE
  hOutput: THandle;   // HANDLE
  dwFlags: DWORD;   // DWORD
  phPC: Pointer   // HPCON* out
): Integer; stdcall;
  external 'KERNEL32.dll' name 'CreatePseudoConsole';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreatePseudoConsole"
  c_CreatePseudoConsole :: COORD -> Ptr () -> Ptr () -> Word32 -> Ptr CIntPtr -> IO Int32
-- size : COORD -> COORD
-- hInput : HANDLE -> Ptr ()
-- hOutput : HANDLE -> Ptr ()
-- dwFlags : DWORD -> Word32
-- phPC : HPCON* out -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

let createpseudoconsole =
  foreign "CreatePseudoConsole"
    (COORD @-> (ptr void) @-> (ptr void) @-> uint32_t @-> (ptr intptr_t) @-> returning int32_t)
(* size : COORD -> COORD *)
(* hInput : HANDLE -> (ptr void) *)
(* hOutput : HANDLE -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* phPC : HPCON* out -> (ptr intptr_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CreatePseudoConsole" create-pseudo-console :convention :stdcall) :int32
  (size (:struct coord))   ; COORD
  (h-input :pointer)   ; HANDLE
  (h-output :pointer)   ; HANDLE
  (dw-flags :uint32)   ; DWORD
  (ph-pc :pointer))   ; HPCON* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreatePseudoConsole = Win32::API::More->new('KERNEL32',
    'int CreatePseudoConsole(LPVOID size, HANDLE hInput, HANDLE hOutput, DWORD dwFlags, LPVOID phPC)');
# my $ret = $CreatePseudoConsole->Call($size, $hInput, $hOutput, $dwFlags, $phPC);
# size : COORD -> LPVOID
# hInput : HANDLE -> HANDLE
# hOutput : HANDLE -> HANDLE
# dwFlags : DWORD -> DWORD
# phPC : HPCON* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型