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

WriteConsoleW

関数
コンソール画面バッファに文字列を書き込む(Unicode版)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL WriteConsoleW(
    HANDLE hConsoleOutput,
    LPCWSTR lpBuffer,
    DWORD nNumberOfCharsToWrite,
    DWORD* lpNumberOfCharsWritten,   // optional
    void* lpReserved   // optional
);

パラメーター

名前方向説明
hConsoleOutputHANDLEin書き込み先のコンソール画面バッファのハンドル。
lpBufferLPCWSTRin書き込むワイド文字データを格納したバッファへのポインタ。
nNumberOfCharsToWriteDWORDin書き込む文字数。
lpNumberOfCharsWrittenDWORD*outoptional実際に書き込んだ文字数を受け取る出力DWORDポインタ。
lpReservedvoid*optional予約済みパラメータ。NULLを指定する。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL WriteConsoleW(
    HANDLE hConsoleOutput,
    LPCWSTR lpBuffer,
    DWORD nNumberOfCharsToWrite,
    DWORD* lpNumberOfCharsWritten,   // optional
    void* lpReserved   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool WriteConsoleW(
    IntPtr hConsoleOutput,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string lpBuffer,   // LPCWSTR
    uint nNumberOfCharsToWrite,   // DWORD
    IntPtr lpNumberOfCharsWritten,   // DWORD* optional, out
    IntPtr lpReserved   // void* optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WriteConsoleW(
    hConsoleOutput As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> lpBuffer As String,   ' LPCWSTR
    nNumberOfCharsToWrite As UInteger,   ' DWORD
    lpNumberOfCharsWritten As IntPtr,   ' DWORD* optional, out
    lpReserved As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hConsoleOutput : HANDLE
' lpBuffer : LPCWSTR
' nNumberOfCharsToWrite : DWORD
' lpNumberOfCharsWritten : DWORD* optional, out
' lpReserved : void* optional
Declare PtrSafe Function WriteConsoleW Lib "kernel32" ( _
    ByVal hConsoleOutput As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByVal nNumberOfCharsToWrite As Long, _
    ByVal lpNumberOfCharsWritten As LongPtr, _
    ByVal lpReserved As LongPtr) 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

WriteConsoleW = ctypes.windll.kernel32.WriteConsoleW
WriteConsoleW.restype = wintypes.BOOL
WriteConsoleW.argtypes = [
    wintypes.HANDLE,  # hConsoleOutput : HANDLE
    wintypes.LPCWSTR,  # lpBuffer : LPCWSTR
    wintypes.DWORD,  # nNumberOfCharsToWrite : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpNumberOfCharsWritten : DWORD* optional, out
    ctypes.POINTER(None),  # lpReserved : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
WriteConsoleW = Fiddle::Function.new(
  lib['WriteConsoleW'],
  [
    Fiddle::TYPE_VOIDP,  # hConsoleOutput : HANDLE
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPCWSTR
    -Fiddle::TYPE_INT,  # nNumberOfCharsToWrite : DWORD
    Fiddle::TYPE_VOIDP,  # lpNumberOfCharsWritten : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpReserved : void* optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn WriteConsoleW(
        hConsoleOutput: *mut core::ffi::c_void,  // HANDLE
        lpBuffer: *const u16,  // LPCWSTR
        nNumberOfCharsToWrite: u32,  // DWORD
        lpNumberOfCharsWritten: *mut u32,  // DWORD* optional, out
        lpReserved: *mut ()  // void* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool WriteConsoleW(IntPtr hConsoleOutput, [MarshalAs(UnmanagedType.LPWStr)] string lpBuffer, uint nNumberOfCharsToWrite, IntPtr lpNumberOfCharsWritten, IntPtr lpReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_WriteConsoleW' -Namespace Win32 -PassThru
# $api::WriteConsoleW(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved)
#uselib "KERNEL32.dll"
#func global WriteConsoleW "WriteConsoleW" wptr, wptr, wptr, wptr, wptr
; WriteConsoleW hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, varptr(lpNumberOfCharsWritten), lpReserved   ; 戻り値は stat
; hConsoleOutput : HANDLE -> "wptr"
; lpBuffer : LPCWSTR -> "wptr"
; nNumberOfCharsToWrite : DWORD -> "wptr"
; lpNumberOfCharsWritten : DWORD* optional, out -> "wptr"
; lpReserved : void* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global WriteConsoleW "WriteConsoleW" sptr, wstr, int, var, sptr
; res = WriteConsoleW(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved)
; hConsoleOutput : HANDLE -> "sptr"
; lpBuffer : LPCWSTR -> "wstr"
; nNumberOfCharsToWrite : DWORD -> "int"
; lpNumberOfCharsWritten : DWORD* optional, out -> "var"
; lpReserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL WriteConsoleW(HANDLE hConsoleOutput, LPCWSTR lpBuffer, DWORD nNumberOfCharsToWrite, DWORD* lpNumberOfCharsWritten, void* lpReserved)
#uselib "KERNEL32.dll"
#cfunc global WriteConsoleW "WriteConsoleW" intptr, wstr, int, var, intptr
; res = WriteConsoleW(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved)
; hConsoleOutput : HANDLE -> "intptr"
; lpBuffer : LPCWSTR -> "wstr"
; nNumberOfCharsToWrite : DWORD -> "int"
; lpNumberOfCharsWritten : DWORD* optional, out -> "var"
; lpReserved : void* optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWriteConsoleW = kernel32.NewProc("WriteConsoleW")
)

// hConsoleOutput (HANDLE), lpBuffer (LPCWSTR), nNumberOfCharsToWrite (DWORD), lpNumberOfCharsWritten (DWORD* optional, out), lpReserved (void* optional)
r1, _, err := procWriteConsoleW.Call(
	uintptr(hConsoleOutput),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpBuffer))),
	uintptr(nNumberOfCharsToWrite),
	uintptr(lpNumberOfCharsWritten),
	uintptr(lpReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WriteConsoleW(
  hConsoleOutput: THandle;   // HANDLE
  lpBuffer: PWideChar;   // LPCWSTR
  nNumberOfCharsToWrite: DWORD;   // DWORD
  lpNumberOfCharsWritten: Pointer;   // DWORD* optional, out
  lpReserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WriteConsoleW';
result := DllCall("KERNEL32\WriteConsoleW"
    , "Ptr", hConsoleOutput   ; HANDLE
    , "WStr", lpBuffer   ; LPCWSTR
    , "UInt", nNumberOfCharsToWrite   ; DWORD
    , "Ptr", lpNumberOfCharsWritten   ; DWORD* optional, out
    , "Ptr", lpReserved   ; void* optional
    , "Int")   ; return: BOOL
●WriteConsoleW(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved) = DLL("KERNEL32.dll", "bool WriteConsoleW(void*, char*, dword, void*, void*)")
# 呼び出し: WriteConsoleW(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved)
# hConsoleOutput : HANDLE -> "void*"
# lpBuffer : LPCWSTR -> "char*"
# nNumberOfCharsToWrite : DWORD -> "dword"
# lpNumberOfCharsWritten : DWORD* optional, out -> "void*"
# lpReserved : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn WriteConsoleW(
    hConsoleOutput: ?*anyopaque, // HANDLE
    lpBuffer: [*c]const u16, // LPCWSTR
    nNumberOfCharsToWrite: u32, // DWORD
    lpNumberOfCharsWritten: [*c]u32, // DWORD* optional, out
    lpReserved: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc WriteConsoleW(
    hConsoleOutput: pointer,  # HANDLE
    lpBuffer: WideCString,  # LPCWSTR
    nNumberOfCharsToWrite: uint32,  # DWORD
    lpNumberOfCharsWritten: ptr uint32,  # DWORD* optional, out
    lpReserved: pointer  # void* optional
): int32 {.importc: "WriteConsoleW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int WriteConsoleW(
    void* hConsoleOutput,   // HANDLE
    const(wchar)* lpBuffer,   // LPCWSTR
    uint nNumberOfCharsToWrite,   // DWORD
    uint* lpNumberOfCharsWritten,   // DWORD* optional, out
    void* lpReserved   // void* optional
);
ccall((:WriteConsoleW, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, UInt32, Ptr{UInt32}, Ptr{Cvoid}),
      hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved)
# hConsoleOutput : HANDLE -> Ptr{Cvoid}
# lpBuffer : LPCWSTR -> Cwstring
# nNumberOfCharsToWrite : DWORD -> UInt32
# lpNumberOfCharsWritten : DWORD* optional, out -> Ptr{UInt32}
# lpReserved : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t WriteConsoleW(
    void* hConsoleOutput,
    const uint16_t* lpBuffer,
    uint32_t nNumberOfCharsToWrite,
    uint32_t* lpNumberOfCharsWritten,
    void* lpReserved);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.WriteConsoleW(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved)
-- hConsoleOutput : HANDLE
-- lpBuffer : LPCWSTR
-- nNumberOfCharsToWrite : DWORD
-- lpNumberOfCharsWritten : DWORD* optional, out
-- lpReserved : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const WriteConsoleW = lib.func('__stdcall', 'WriteConsoleW', 'int32_t', ['void *', 'str16', 'uint32_t', 'uint32_t *', 'void *']);
// WriteConsoleW(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved)
// hConsoleOutput : HANDLE -> 'void *'
// lpBuffer : LPCWSTR -> 'str16'
// nNumberOfCharsToWrite : DWORD -> 'uint32_t'
// lpNumberOfCharsWritten : DWORD* optional, out -> 'uint32_t *'
// lpReserved : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  WriteConsoleW: { parameters: ["pointer", "buffer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WriteConsoleW(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved)
// hConsoleOutput : HANDLE -> "pointer"
// lpBuffer : LPCWSTR -> "buffer"
// nNumberOfCharsToWrite : DWORD -> "u32"
// lpNumberOfCharsWritten : DWORD* optional, out -> "pointer"
// lpReserved : void* optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WriteConsoleW(
    void* hConsoleOutput,
    const uint16_t* lpBuffer,
    uint32_t nNumberOfCharsToWrite,
    uint32_t* lpNumberOfCharsWritten,
    void* lpReserved);
C, "KERNEL32.dll");
// $ffi->WriteConsoleW(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved);
// hConsoleOutput : HANDLE
// lpBuffer : LPCWSTR
// nNumberOfCharsToWrite : DWORD
// lpNumberOfCharsWritten : DWORD* optional, out
// lpReserved : void* 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.UNICODE_OPTIONS);
    boolean WriteConsoleW(
        Pointer hConsoleOutput,   // HANDLE
        WString lpBuffer,   // LPCWSTR
        int nNumberOfCharsToWrite,   // DWORD
        IntByReference lpNumberOfCharsWritten,   // DWORD* optional, out
        Pointer lpReserved   // void* optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun WriteConsoleW = WriteConsoleW(
    hConsoleOutput : Void*,   # HANDLE
    lpBuffer : UInt16*,   # LPCWSTR
    nNumberOfCharsToWrite : UInt32,   # DWORD
    lpNumberOfCharsWritten : UInt32*,   # DWORD* optional, out
    lpReserved : Void*   # void* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WriteConsoleWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, Pointer<Uint32>, Pointer<Void>);
typedef WriteConsoleWDart = int Function(Pointer<Void>, Pointer<Utf16>, int, Pointer<Uint32>, Pointer<Void>);
final WriteConsoleW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<WriteConsoleWNative, WriteConsoleWDart>('WriteConsoleW');
// hConsoleOutput : HANDLE -> Pointer<Void>
// lpBuffer : LPCWSTR -> Pointer<Utf16>
// nNumberOfCharsToWrite : DWORD -> Uint32
// lpNumberOfCharsWritten : DWORD* optional, out -> Pointer<Uint32>
// lpReserved : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WriteConsoleW(
  hConsoleOutput: THandle;   // HANDLE
  lpBuffer: PWideChar;   // LPCWSTR
  nNumberOfCharsToWrite: DWORD;   // DWORD
  lpNumberOfCharsWritten: Pointer;   // DWORD* optional, out
  lpReserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WriteConsoleW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WriteConsoleW"
  c_WriteConsoleW :: Ptr () -> CWString -> Word32 -> Ptr Word32 -> Ptr () -> IO CInt
-- hConsoleOutput : HANDLE -> Ptr ()
-- lpBuffer : LPCWSTR -> CWString
-- nNumberOfCharsToWrite : DWORD -> Word32
-- lpNumberOfCharsWritten : DWORD* optional, out -> Ptr Word32
-- lpReserved : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let writeconsolew =
  foreign "WriteConsoleW"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* hConsoleOutput : HANDLE -> (ptr void) *)
(* lpBuffer : LPCWSTR -> (ptr uint16_t) *)
(* nNumberOfCharsToWrite : DWORD -> uint32_t *)
(* lpNumberOfCharsWritten : DWORD* optional, out -> (ptr uint32_t) *)
(* lpReserved : void* 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 ("WriteConsoleW" write-console-w :convention :stdcall) :int32
  (h-console-output :pointer)   ; HANDLE
  (lp-buffer (:string :encoding :utf-16le))   ; LPCWSTR
  (n-number-of-chars-to-write :uint32)   ; DWORD
  (lp-number-of-chars-written :pointer)   ; DWORD* optional, out
  (lp-reserved :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WriteConsoleW = Win32::API::More->new('KERNEL32',
    'BOOL WriteConsoleW(HANDLE hConsoleOutput, LPCWSTR lpBuffer, DWORD nNumberOfCharsToWrite, LPVOID lpNumberOfCharsWritten, LPVOID lpReserved)');
# my $ret = $WriteConsoleW->Call($hConsoleOutput, $lpBuffer, $nNumberOfCharsToWrite, $lpNumberOfCharsWritten, $lpReserved);
# hConsoleOutput : HANDLE -> HANDLE
# lpBuffer : LPCWSTR -> LPCWSTR
# nNumberOfCharsToWrite : DWORD -> DWORD
# lpNumberOfCharsWritten : DWORD* optional, out -> LPVOID
# lpReserved : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い