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

OpenConsoleW

関数
指定したコンソールデバイスを開いてハンドルを取得する内部関数。
DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

HANDLE OpenConsoleW(
    LPWSTR lpConsoleDevice,
    DWORD dwDesiredAccess,
    BOOL bInheritHandle,
    DWORD dwShareMode
);

パラメーター

名前方向説明
lpConsoleDeviceLPWSTRin開くコンソールデバイス名(\"CONIN$\"や\"CONOUT$\"等)を指すUnicode文字列。
dwDesiredAccessDWORDin要求するアクセス権(GENERIC_READ/GENERIC_WRITE等)を示すフラグ。
bInheritHandleBOOLin返されるハンドルを子プロセスに継承させるならTRUEを指定する。
dwShareModeDWORDin共有モード(FILE_SHARE_READ/FILE_SHARE_WRITE等)を示すフラグ。

戻り値の型: HANDLE

各言語での呼び出し定義

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

HANDLE OpenConsoleW(
    LPWSTR lpConsoleDevice,
    DWORD dwDesiredAccess,
    BOOL bInheritHandle,
    DWORD dwShareMode
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern IntPtr OpenConsoleW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpConsoleDevice,   // LPWSTR
    uint dwDesiredAccess,   // DWORD
    bool bInheritHandle,   // BOOL
    uint dwShareMode   // DWORD
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function OpenConsoleW(
    <MarshalAs(UnmanagedType.LPWStr)> lpConsoleDevice As String,   ' LPWSTR
    dwDesiredAccess As UInteger,   ' DWORD
    bInheritHandle As Boolean,   ' BOOL
    dwShareMode As UInteger   ' DWORD
) As IntPtr
End Function
' lpConsoleDevice : LPWSTR
' dwDesiredAccess : DWORD
' bInheritHandle : BOOL
' dwShareMode : DWORD
Declare PtrSafe Function OpenConsoleW Lib "kernel32" ( _
    ByVal lpConsoleDevice As LongPtr, _
    ByVal dwDesiredAccess As Long, _
    ByVal bInheritHandle As Long, _
    ByVal dwShareMode As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OpenConsoleW = ctypes.windll.kernel32.OpenConsoleW
OpenConsoleW.restype = ctypes.c_void_p
OpenConsoleW.argtypes = [
    wintypes.LPCWSTR,  # lpConsoleDevice : LPWSTR
    wintypes.DWORD,  # dwDesiredAccess : DWORD
    wintypes.BOOL,  # bInheritHandle : BOOL
    wintypes.DWORD,  # dwShareMode : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
OpenConsoleW = Fiddle::Function.new(
  lib['OpenConsoleW'],
  [
    Fiddle::TYPE_VOIDP,  # lpConsoleDevice : LPWSTR
    -Fiddle::TYPE_INT,  # dwDesiredAccess : DWORD
    Fiddle::TYPE_INT,  # bInheritHandle : BOOL
    -Fiddle::TYPE_INT,  # dwShareMode : DWORD
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn OpenConsoleW(
        lpConsoleDevice: *mut u16,  // LPWSTR
        dwDesiredAccess: u32,  // DWORD
        bInheritHandle: i32,  // BOOL
        dwShareMode: u32  // DWORD
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern IntPtr OpenConsoleW([MarshalAs(UnmanagedType.LPWStr)] string lpConsoleDevice, uint dwDesiredAccess, bool bInheritHandle, uint dwShareMode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_OpenConsoleW' -Namespace Win32 -PassThru
# $api::OpenConsoleW(lpConsoleDevice, dwDesiredAccess, bInheritHandle, dwShareMode)
#uselib "KERNEL32.dll"
#func global OpenConsoleW "OpenConsoleW" sptr, sptr, sptr, sptr
; OpenConsoleW lpConsoleDevice, dwDesiredAccess, bInheritHandle, dwShareMode   ; 戻り値は stat
; lpConsoleDevice : LPWSTR -> "sptr"
; dwDesiredAccess : DWORD -> "sptr"
; bInheritHandle : BOOL -> "sptr"
; dwShareMode : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global OpenConsoleW "OpenConsoleW" wstr, int, int, int
; res = OpenConsoleW(lpConsoleDevice, dwDesiredAccess, bInheritHandle, dwShareMode)
; lpConsoleDevice : LPWSTR -> "wstr"
; dwDesiredAccess : DWORD -> "int"
; bInheritHandle : BOOL -> "int"
; dwShareMode : DWORD -> "int"
; HANDLE OpenConsoleW(LPWSTR lpConsoleDevice, DWORD dwDesiredAccess, BOOL bInheritHandle, DWORD dwShareMode)
#uselib "KERNEL32.dll"
#cfunc global OpenConsoleW "OpenConsoleW" wstr, int, int, int
; res = OpenConsoleW(lpConsoleDevice, dwDesiredAccess, bInheritHandle, dwShareMode)
; lpConsoleDevice : LPWSTR -> "wstr"
; dwDesiredAccess : DWORD -> "int"
; bInheritHandle : BOOL -> "int"
; dwShareMode : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procOpenConsoleW = kernel32.NewProc("OpenConsoleW")
)

// lpConsoleDevice (LPWSTR), dwDesiredAccess (DWORD), bInheritHandle (BOOL), dwShareMode (DWORD)
r1, _, err := procOpenConsoleW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpConsoleDevice))),
	uintptr(dwDesiredAccess),
	uintptr(bInheritHandle),
	uintptr(dwShareMode),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function OpenConsoleW(
  lpConsoleDevice: PWideChar;   // LPWSTR
  dwDesiredAccess: DWORD;   // DWORD
  bInheritHandle: BOOL;   // BOOL
  dwShareMode: DWORD   // DWORD
): THandle; stdcall;
  external 'KERNEL32.dll' name 'OpenConsoleW';
result := DllCall("KERNEL32\OpenConsoleW"
    , "WStr", lpConsoleDevice   ; LPWSTR
    , "UInt", dwDesiredAccess   ; DWORD
    , "Int", bInheritHandle   ; BOOL
    , "UInt", dwShareMode   ; DWORD
    , "Ptr")   ; return: HANDLE
●OpenConsoleW(lpConsoleDevice, dwDesiredAccess, bInheritHandle, dwShareMode) = DLL("KERNEL32.dll", "void* OpenConsoleW(char*, dword, bool, dword)")
# 呼び出し: OpenConsoleW(lpConsoleDevice, dwDesiredAccess, bInheritHandle, dwShareMode)
# lpConsoleDevice : LPWSTR -> "char*"
# dwDesiredAccess : DWORD -> "dword"
# bInheritHandle : BOOL -> "bool"
# dwShareMode : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef OpenConsoleWNative = Pointer<Void> Function(Pointer<Utf16>, Uint32, Int32, Uint32);
typedef OpenConsoleWDart = Pointer<Void> Function(Pointer<Utf16>, int, int, int);
final OpenConsoleW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<OpenConsoleWNative, OpenConsoleWDart>('OpenConsoleW');
// lpConsoleDevice : LPWSTR -> Pointer<Utf16>
// dwDesiredAccess : DWORD -> Uint32
// bInheritHandle : BOOL -> Int32
// dwShareMode : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OpenConsoleW(
  lpConsoleDevice: PWideChar;   // LPWSTR
  dwDesiredAccess: DWORD;   // DWORD
  bInheritHandle: BOOL;   // BOOL
  dwShareMode: DWORD   // DWORD
): THandle; stdcall;
  external 'KERNEL32.dll' name 'OpenConsoleW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OpenConsoleW"
  c_OpenConsoleW :: CWString -> Word32 -> CInt -> Word32 -> IO (Ptr ())
-- lpConsoleDevice : LPWSTR -> CWString
-- dwDesiredAccess : DWORD -> Word32
-- bInheritHandle : BOOL -> CInt
-- dwShareMode : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let openconsolew =
  foreign "OpenConsoleW"
    ((ptr uint16_t) @-> uint32_t @-> int32_t @-> uint32_t @-> returning (ptr void))
(* lpConsoleDevice : LPWSTR -> (ptr uint16_t) *)
(* dwDesiredAccess : DWORD -> uint32_t *)
(* bInheritHandle : BOOL -> int32_t *)
(* dwShareMode : 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 ("OpenConsoleW" open-console-w :convention :stdcall) :pointer
  (lp-console-device (:string :encoding :utf-16le))   ; LPWSTR
  (dw-desired-access :uint32)   ; DWORD
  (b-inherit-handle :int32)   ; BOOL
  (dw-share-mode :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenConsoleW = Win32::API::More->new('KERNEL32',
    'HANDLE OpenConsoleW(LPCWSTR lpConsoleDevice, DWORD dwDesiredAccess, BOOL bInheritHandle, DWORD dwShareMode)');
# my $ret = $OpenConsoleW->Call($lpConsoleDevice, $dwDesiredAccess, $bInheritHandle, $dwShareMode);
# lpConsoleDevice : LPWSTR -> LPCWSTR
# dwDesiredAccess : DWORD -> DWORD
# bInheritHandle : BOOL -> BOOL
# dwShareMode : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。