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

WriteConsoleOutputCharacterA

関数
コンソール画面の指定位置に文字列を書き込む(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL WriteConsoleOutputCharacterA(
    HANDLE hConsoleOutput,
    LPCSTR lpCharacter,
    DWORD nLength,
    COORD dwWriteCoord,
    DWORD* lpNumberOfCharsWritten
);

パラメーター

名前型方向説明
hConsoleOutputHANDLEin対象のコンソール画面バッファのハンドル。
lpCharacterLPCSTRin書き込む文字列を格納したANSIバッファへのポインタ。
nLengthDWORDin書き込む文字数。
dwWriteCoordCOORDin書き込み開始位置の座標を示すCOORD値。
lpNumberOfCharsWrittenDWORD*out実際に書き込んだ文字数を受け取る出力DWORDポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL WriteConsoleOutputCharacterA(
    HANDLE hConsoleOutput,
    LPCSTR lpCharacter,
    DWORD nLength,
    COORD dwWriteCoord,
    DWORD* lpNumberOfCharsWritten
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool WriteConsoleOutputCharacterA(
    IntPtr hConsoleOutput,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string lpCharacter,   // LPCSTR
    uint nLength,   // DWORD
    COORD dwWriteCoord,   // COORD
    out uint lpNumberOfCharsWritten   // DWORD* out
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WriteConsoleOutputCharacterA(
    hConsoleOutput As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> lpCharacter As String,   ' LPCSTR
    nLength As UInteger,   ' DWORD
    dwWriteCoord As COORD,   ' COORD
    <Out> ByRef lpNumberOfCharsWritten As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hConsoleOutput : HANDLE
' lpCharacter : LPCSTR
' nLength : DWORD
' dwWriteCoord : COORD
' lpNumberOfCharsWritten : DWORD* out
Declare PtrSafe Function WriteConsoleOutputCharacterA Lib "kernel32" ( _
    ByVal hConsoleOutput As LongPtr, _
    ByVal lpCharacter As String, _
    ByVal nLength As Long, _
    ByVal dwWriteCoord As LongPtr, _
    ByRef lpNumberOfCharsWritten As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WriteConsoleOutputCharacterA = ctypes.windll.kernel32.WriteConsoleOutputCharacterA
WriteConsoleOutputCharacterA.restype = wintypes.BOOL
WriteConsoleOutputCharacterA.argtypes = [
    wintypes.HANDLE,  # hConsoleOutput : HANDLE
    wintypes.LPCSTR,  # lpCharacter : LPCSTR
    wintypes.DWORD,  # nLength : DWORD
    COORD,  # dwWriteCoord : COORD
    ctypes.POINTER(wintypes.DWORD),  # lpNumberOfCharsWritten : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
WriteConsoleOutputCharacterA = Fiddle::Function.new(
  lib['WriteConsoleOutputCharacterA'],
  [
    Fiddle::TYPE_VOIDP,  # hConsoleOutput : HANDLE
    Fiddle::TYPE_VOIDP,  # lpCharacter : LPCSTR
    -Fiddle::TYPE_INT,  # nLength : DWORD
    Fiddle::TYPE_VOIDP,  # dwWriteCoord : COORD
    Fiddle::TYPE_VOIDP,  # lpNumberOfCharsWritten : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn WriteConsoleOutputCharacterA(
        hConsoleOutput: *mut core::ffi::c_void,  // HANDLE
        lpCharacter: *const u8,  // LPCSTR
        nLength: u32,  // DWORD
        dwWriteCoord: COORD,  // COORD
        lpNumberOfCharsWritten: *mut u32  // DWORD* out
    ) -> 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 WriteConsoleOutputCharacterA(IntPtr hConsoleOutput, [MarshalAs(UnmanagedType.LPStr)] string lpCharacter, uint nLength, COORD dwWriteCoord, out uint lpNumberOfCharsWritten);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_WriteConsoleOutputCharacterA' -Namespace Win32 -PassThru
# $api::WriteConsoleOutputCharacterA(hConsoleOutput, lpCharacter, nLength, dwWriteCoord, lpNumberOfCharsWritten)
#uselib "KERNEL32.dll"
#func global WriteConsoleOutputCharacterA "WriteConsoleOutputCharacterA" sptr, sptr, sptr, sptr, sptr
; WriteConsoleOutputCharacterA hConsoleOutput, lpCharacter, nLength, dwWriteCoord, varptr(lpNumberOfCharsWritten)   ; 戻り値は stat
; hConsoleOutput : HANDLE -> "sptr"
; lpCharacter : LPCSTR -> "sptr"
; nLength : DWORD -> "sptr"
; dwWriteCoord : COORD -> "sptr"
; lpNumberOfCharsWritten : DWORD* out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "KERNEL32.dll"
#cfunc global WriteConsoleOutputCharacterA "WriteConsoleOutputCharacterA" sptr, str, int, int, var
; res = WriteConsoleOutputCharacterA(hConsoleOutput, lpCharacter, nLength, dwWriteCoord, lpNumberOfCharsWritten)
; hConsoleOutput : HANDLE -> "sptr"
; lpCharacter : LPCSTR -> "str"
; nLength : DWORD -> "int"
; dwWriteCoord : COORD -> "int"
; lpNumberOfCharsWritten : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; BOOL WriteConsoleOutputCharacterA(HANDLE hConsoleOutput, LPCSTR lpCharacter, DWORD nLength, COORD dwWriteCoord, DWORD* lpNumberOfCharsWritten)
#uselib "KERNEL32.dll"
#cfunc global WriteConsoleOutputCharacterA "WriteConsoleOutputCharacterA" intptr, str, int, int, var
; res = WriteConsoleOutputCharacterA(hConsoleOutput, lpCharacter, nLength, dwWriteCoord, lpNumberOfCharsWritten)
; hConsoleOutput : HANDLE -> "intptr"
; lpCharacter : LPCSTR -> "str"
; nLength : DWORD -> "int"
; dwWriteCoord : COORD -> "int"
; lpNumberOfCharsWritten : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWriteConsoleOutputCharacterA = kernel32.NewProc("WriteConsoleOutputCharacterA")
)

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

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

typedef WriteConsoleOutputCharacterANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Uint32, COORD, Pointer<Uint32>);
typedef WriteConsoleOutputCharacterADart = int Function(Pointer<Void>, Pointer<Utf8>, int, int, Pointer<Uint32>);
final WriteConsoleOutputCharacterA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<WriteConsoleOutputCharacterANative, WriteConsoleOutputCharacterADart>('WriteConsoleOutputCharacterA');
// hConsoleOutput : HANDLE -> Pointer<Void>
// lpCharacter : LPCSTR -> Pointer<Utf8>
// nLength : DWORD -> Uint32
// dwWriteCoord : COORD -> COORD
// lpNumberOfCharsWritten : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WriteConsoleOutputCharacterA(
  hConsoleOutput: THandle;   // HANDLE
  lpCharacter: PAnsiChar;   // LPCSTR
  nLength: DWORD;   // DWORD
  dwWriteCoord: COORD;   // COORD
  lpNumberOfCharsWritten: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WriteConsoleOutputCharacterA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WriteConsoleOutputCharacterA"
  c_WriteConsoleOutputCharacterA :: Ptr () -> CString -> Word32 -> COORD -> Ptr Word32 -> IO CInt
-- hConsoleOutput : HANDLE -> Ptr ()
-- lpCharacter : LPCSTR -> CString
-- nLength : DWORD -> Word32
-- dwWriteCoord : COORD -> COORD
-- lpNumberOfCharsWritten : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

let writeconsoleoutputcharactera =
  foreign "WriteConsoleOutputCharacterA"
    ((ptr void) @-> string @-> uint32_t @-> COORD @-> (ptr uint32_t) @-> returning int32_t)
(* hConsoleOutput : HANDLE -> (ptr void) *)
(* lpCharacter : LPCSTR -> string *)
(* nLength : DWORD -> uint32_t *)
(* dwWriteCoord : COORD -> COORD *)
(* lpNumberOfCharsWritten : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("WriteConsoleOutputCharacterA" write-console-output-character-a :convention :stdcall) :int32
  (h-console-output :pointer)   ; HANDLE
  (lp-character :string)   ; LPCSTR
  (n-length :uint32)   ; DWORD
  (dw-write-coord (:struct coord))   ; COORD
  (lp-number-of-chars-written :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WriteConsoleOutputCharacterA = Win32::API::More->new('KERNEL32',
    'BOOL WriteConsoleOutputCharacterA(HANDLE hConsoleOutput, LPCSTR lpCharacter, DWORD nLength, LPVOID dwWriteCoord, LPVOID lpNumberOfCharsWritten)');
# my $ret = $WriteConsoleOutputCharacterA->Call($hConsoleOutput, $lpCharacter, $nLength, $dwWriteCoord, $lpNumberOfCharsWritten);
# hConsoleOutput : HANDLE -> HANDLE
# lpCharacter : LPCSTR -> LPCSTR
# nLength : DWORD -> DWORD
# dwWriteCoord : COORD -> LPVOID
# lpNumberOfCharsWritten : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型