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

WriteConsoleA

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

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

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

パラメーター

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

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL WriteConsoleA(
    HANDLE hConsoleOutput,
    LPCSTR lpBuffer,
    DWORD nNumberOfCharsToWrite,
    DWORD* lpNumberOfCharsWritten,   // optional
    void* lpReserved   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool WriteConsoleA(
    IntPtr hConsoleOutput,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string lpBuffer,   // LPCSTR
    uint nNumberOfCharsToWrite,   // DWORD
    IntPtr lpNumberOfCharsWritten,   // DWORD* optional, out
    IntPtr lpReserved   // void* optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WriteConsoleA(
    hConsoleOutput As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> lpBuffer As String,   ' LPCSTR
    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 : LPCSTR
' nNumberOfCharsToWrite : DWORD
' lpNumberOfCharsWritten : DWORD* optional, out
' lpReserved : void* optional
Declare PtrSafe Function WriteConsoleA Lib "kernel32" ( _
    ByVal hConsoleOutput As LongPtr, _
    ByVal lpBuffer As String, _
    ByVal nNumberOfCharsToWrite As Long, _
    ByVal lpNumberOfCharsWritten As LongPtr, _
    ByVal lpReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WriteConsoleA = ctypes.windll.kernel32.WriteConsoleA
WriteConsoleA.restype = wintypes.BOOL
WriteConsoleA.argtypes = [
    wintypes.HANDLE,  # hConsoleOutput : HANDLE
    wintypes.LPCSTR,  # lpBuffer : LPCSTR
    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')
WriteConsoleA = Fiddle::Function.new(
  lib['WriteConsoleA'],
  [
    Fiddle::TYPE_VOIDP,  # hConsoleOutput : HANDLE
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPCSTR
    -Fiddle::TYPE_INT,  # nNumberOfCharsToWrite : DWORD
    Fiddle::TYPE_VOIDP,  # lpNumberOfCharsWritten : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpReserved : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn WriteConsoleA(
        hConsoleOutput: *mut core::ffi::c_void,  // HANDLE
        lpBuffer: *const u8,  // LPCSTR
        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.Ansi, SetLastError = true)]
public static extern bool WriteConsoleA(IntPtr hConsoleOutput, [MarshalAs(UnmanagedType.LPStr)] string lpBuffer, uint nNumberOfCharsToWrite, IntPtr lpNumberOfCharsWritten, IntPtr lpReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_WriteConsoleA' -Namespace Win32 -PassThru
# $api::WriteConsoleA(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved)
#uselib "KERNEL32.dll"
#func global WriteConsoleA "WriteConsoleA" sptr, sptr, sptr, sptr, sptr
; WriteConsoleA hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, varptr(lpNumberOfCharsWritten), lpReserved   ; 戻り値は stat
; hConsoleOutput : HANDLE -> "sptr"
; lpBuffer : LPCSTR -> "sptr"
; nNumberOfCharsToWrite : DWORD -> "sptr"
; lpNumberOfCharsWritten : DWORD* optional, out -> "sptr"
; lpReserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global WriteConsoleA "WriteConsoleA" sptr, str, int, var, sptr
; res = WriteConsoleA(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved)
; hConsoleOutput : HANDLE -> "sptr"
; lpBuffer : LPCSTR -> "str"
; nNumberOfCharsToWrite : DWORD -> "int"
; lpNumberOfCharsWritten : DWORD* optional, out -> "var"
; lpReserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL WriteConsoleA(HANDLE hConsoleOutput, LPCSTR lpBuffer, DWORD nNumberOfCharsToWrite, DWORD* lpNumberOfCharsWritten, void* lpReserved)
#uselib "KERNEL32.dll"
#cfunc global WriteConsoleA "WriteConsoleA" intptr, str, int, var, intptr
; res = WriteConsoleA(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved)
; hConsoleOutput : HANDLE -> "intptr"
; lpBuffer : LPCSTR -> "str"
; 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")
	procWriteConsoleA = kernel32.NewProc("WriteConsoleA")
)

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

extern "kernel32" fn WriteConsoleA(
    hConsoleOutput: ?*anyopaque, // HANDLE
    lpBuffer: [*c]const u8, // LPCSTR
    nNumberOfCharsToWrite: u32, // DWORD
    lpNumberOfCharsWritten: [*c]u32, // DWORD* optional, out
    lpReserved: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
proc WriteConsoleA(
    hConsoleOutput: pointer,  # HANDLE
    lpBuffer: cstring,  # LPCSTR
    nNumberOfCharsToWrite: uint32,  # DWORD
    lpNumberOfCharsWritten: ptr uint32,  # DWORD* optional, out
    lpReserved: pointer  # void* optional
): int32 {.importc: "WriteConsoleA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int WriteConsoleA(
    void* hConsoleOutput,   // HANDLE
    const(char)* lpBuffer,   // LPCSTR
    uint nNumberOfCharsToWrite,   // DWORD
    uint* lpNumberOfCharsWritten,   // DWORD* optional, out
    void* lpReserved   // void* optional
);
ccall((:WriteConsoleA, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, UInt32, Ptr{UInt32}, Ptr{Cvoid}),
      hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved)
# hConsoleOutput : HANDLE -> Ptr{Cvoid}
# lpBuffer : LPCSTR -> Cstring
# nNumberOfCharsToWrite : DWORD -> UInt32
# lpNumberOfCharsWritten : DWORD* optional, out -> Ptr{UInt32}
# lpReserved : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WriteConsoleA(
    void* hConsoleOutput,
    const char* lpBuffer,
    uint32_t nNumberOfCharsToWrite,
    uint32_t* lpNumberOfCharsWritten,
    void* lpReserved);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.WriteConsoleA(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved)
-- hConsoleOutput : HANDLE
-- lpBuffer : LPCSTR
-- nNumberOfCharsToWrite : DWORD
-- lpNumberOfCharsWritten : DWORD* optional, out
-- lpReserved : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const WriteConsoleA = lib.func('__stdcall', 'WriteConsoleA', 'int32_t', ['void *', 'str', 'uint32_t', 'uint32_t *', 'void *']);
// WriteConsoleA(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved)
// hConsoleOutput : HANDLE -> 'void *'
// lpBuffer : LPCSTR -> 'str'
// nNumberOfCharsToWrite : DWORD -> 'uint32_t'
// lpNumberOfCharsWritten : DWORD* optional, out -> 'uint32_t *'
// lpReserved : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  WriteConsoleA: { parameters: ["pointer", "buffer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WriteConsoleA(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved)
// hConsoleOutput : HANDLE -> "pointer"
// lpBuffer : LPCSTR -> "buffer"
// nNumberOfCharsToWrite : DWORD -> "u32"
// lpNumberOfCharsWritten : DWORD* optional, out -> "pointer"
// lpReserved : void* optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WriteConsoleA(
    void* hConsoleOutput,
    const char* lpBuffer,
    uint32_t nNumberOfCharsToWrite,
    uint32_t* lpNumberOfCharsWritten,
    void* lpReserved);
C, "KERNEL32.dll");
// $ffi->WriteConsoleA(hConsoleOutput, lpBuffer, nNumberOfCharsToWrite, lpNumberOfCharsWritten, lpReserved);
// hConsoleOutput : HANDLE
// lpBuffer : LPCSTR
// 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.ASCII_OPTIONS);
    boolean WriteConsoleA(
        Pointer hConsoleOutput,   // HANDLE
        String lpBuffer,   // LPCSTR
        int nNumberOfCharsToWrite,   // DWORD
        IntByReference lpNumberOfCharsWritten,   // DWORD* optional, out
        Pointer lpReserved   // void* optional
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun WriteConsoleA = WriteConsoleA(
    hConsoleOutput : Void*,   # HANDLE
    lpBuffer : UInt8*,   # LPCSTR
    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 WriteConsoleANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Uint32, Pointer<Uint32>, Pointer<Void>);
typedef WriteConsoleADart = int Function(Pointer<Void>, Pointer<Utf8>, int, Pointer<Uint32>, Pointer<Void>);
final WriteConsoleA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<WriteConsoleANative, WriteConsoleADart>('WriteConsoleA');
// hConsoleOutput : HANDLE -> Pointer<Void>
// lpBuffer : LPCSTR -> Pointer<Utf8>
// nNumberOfCharsToWrite : DWORD -> Uint32
// lpNumberOfCharsWritten : DWORD* optional, out -> Pointer<Uint32>
// lpReserved : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WriteConsoleA(
  hConsoleOutput: THandle;   // HANDLE
  lpBuffer: PAnsiChar;   // LPCSTR
  nNumberOfCharsToWrite: DWORD;   // DWORD
  lpNumberOfCharsWritten: Pointer;   // DWORD* optional, out
  lpReserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WriteConsoleA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WriteConsoleA"
  c_WriteConsoleA :: Ptr () -> CString -> Word32 -> Ptr Word32 -> Ptr () -> IO CInt
-- hConsoleOutput : HANDLE -> Ptr ()
-- lpBuffer : LPCSTR -> CString
-- 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 writeconsolea =
  foreign "WriteConsoleA"
    ((ptr void) @-> string @-> uint32_t @-> (ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* hConsoleOutput : HANDLE -> (ptr void) *)
(* lpBuffer : LPCSTR -> string *)
(* 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 ("WriteConsoleA" write-console-a :convention :stdcall) :int32
  (h-console-output :pointer)   ; HANDLE
  (lp-buffer :string)   ; LPCSTR
  (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 $WriteConsoleA = Win32::API::More->new('KERNEL32',
    'BOOL WriteConsoleA(HANDLE hConsoleOutput, LPCSTR lpBuffer, DWORD nNumberOfCharsToWrite, LPVOID lpNumberOfCharsWritten, LPVOID lpReserved)');
# my $ret = $WriteConsoleA->Call($hConsoleOutput, $lpBuffer, $nNumberOfCharsToWrite, $lpNumberOfCharsWritten, $lpReserved);
# hConsoleOutput : HANDLE -> HANDLE
# lpBuffer : LPCSTR -> LPCSTR
# nNumberOfCharsToWrite : DWORD -> DWORD
# lpNumberOfCharsWritten : DWORD* optional, out -> LPVOID
# lpReserved : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い