ホーム › System.Console › WriteConsoleOutputA

WriteConsoleOutputA

関数

文字と属性の矩形ブロックをコンソール画面バッファへ書き込む(ANSI版)。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL WriteConsoleOutputA(
    HANDLE hConsoleOutput,
    const CHAR_INFO* lpBuffer,
    COORD dwBufferSize,
    COORD dwBufferCoord,
    SMALL_RECT* lpWriteRegion
);

パラメーター

名前	型	方向
hConsoleOutput	HANDLE	in
lpBuffer	CHAR_INFO*	in
dwBufferSize	COORD	in
dwBufferCoord	COORD	in
lpWriteRegion	SMALL_RECT*	inout

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL WriteConsoleOutputA(
    HANDLE hConsoleOutput,
    const CHAR_INFO* lpBuffer,
    COORD dwBufferSize,
    COORD dwBufferCoord,
    SMALL_RECT* lpWriteRegion
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool WriteConsoleOutputA(
    IntPtr hConsoleOutput,   // HANDLE
    IntPtr lpBuffer,   // CHAR_INFO*
    COORD dwBufferSize,   // COORD
    COORD dwBufferCoord,   // COORD
    IntPtr lpWriteRegion   // SMALL_RECT* in/out
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WriteConsoleOutputA(
    hConsoleOutput As IntPtr,   ' HANDLE
    lpBuffer As IntPtr,   ' CHAR_INFO*
    dwBufferSize As COORD,   ' COORD
    dwBufferCoord As COORD,   ' COORD
    lpWriteRegion As IntPtr   ' SMALL_RECT* in/out
) As Boolean
End Function

' hConsoleOutput : HANDLE
' lpBuffer : CHAR_INFO*
' dwBufferSize : COORD
' dwBufferCoord : COORD
' lpWriteRegion : SMALL_RECT* in/out
Declare PtrSafe Function WriteConsoleOutputA Lib "kernel32" ( _
    ByVal hConsoleOutput As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByVal dwBufferSize As LongPtr, _
    ByVal dwBufferCoord As LongPtr, _
    ByVal lpWriteRegion As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WriteConsoleOutputA = ctypes.windll.kernel32.WriteConsoleOutputA
WriteConsoleOutputA.restype = wintypes.BOOL
WriteConsoleOutputA.argtypes = [
    wintypes.HANDLE,  # hConsoleOutput : HANDLE
    ctypes.c_void_p,  # lpBuffer : CHAR_INFO*
    COORD,  # dwBufferSize : COORD
    COORD,  # dwBufferCoord : COORD
    ctypes.c_void_p,  # lpWriteRegion : SMALL_RECT* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
WriteConsoleOutputA = Fiddle::Function.new(
  lib['WriteConsoleOutputA'],
  [
    Fiddle::TYPE_VOIDP,  # hConsoleOutput : HANDLE
    Fiddle::TYPE_VOIDP,  # lpBuffer : CHAR_INFO*
    Fiddle::TYPE_VOIDP,  # dwBufferSize : COORD
    Fiddle::TYPE_VOIDP,  # dwBufferCoord : COORD
    Fiddle::TYPE_VOIDP,  # lpWriteRegion : SMALL_RECT* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn WriteConsoleOutputA(
        hConsoleOutput: *mut core::ffi::c_void,  // HANDLE
        lpBuffer: *const CHAR_INFO,  // CHAR_INFO*
        dwBufferSize: COORD,  // COORD
        dwBufferCoord: COORD,  // COORD
        lpWriteRegion: *mut SMALL_RECT  // SMALL_RECT* in/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 WriteConsoleOutputA(IntPtr hConsoleOutput, IntPtr lpBuffer, COORD dwBufferSize, COORD dwBufferCoord, IntPtr lpWriteRegion);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_WriteConsoleOutputA' -Namespace Win32 -PassThru
# $api::WriteConsoleOutputA(hConsoleOutput, lpBuffer, dwBufferSize, dwBufferCoord, lpWriteRegion)

#uselib "KERNEL32.dll"
#func global WriteConsoleOutputA "WriteConsoleOutputA" sptr, sptr, sptr, sptr, sptr
; WriteConsoleOutputA hConsoleOutput, varptr(lpBuffer), dwBufferSize, dwBufferCoord, varptr(lpWriteRegion)   ; 戻り値は stat
; hConsoleOutput : HANDLE -> "sptr"
; lpBuffer : CHAR_INFO* -> "sptr"
; dwBufferSize : COORD -> "sptr"
; dwBufferCoord : COORD -> "sptr"
; lpWriteRegion : SMALL_RECT* in/out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global WriteConsoleOutputA "WriteConsoleOutputA" sptr, var, int, int, var
; res = WriteConsoleOutputA(hConsoleOutput, lpBuffer, dwBufferSize, dwBufferCoord, lpWriteRegion)
; hConsoleOutput : HANDLE -> "sptr"
; lpBuffer : CHAR_INFO* -> "var"
; dwBufferSize : COORD -> "int"
; dwBufferCoord : COORD -> "int"
; lpWriteRegion : SMALL_RECT* in/out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global WriteConsoleOutputA "WriteConsoleOutputA" sptr, sptr, int, int, sptr
; res = WriteConsoleOutputA(hConsoleOutput, varptr(lpBuffer), dwBufferSize, dwBufferCoord, varptr(lpWriteRegion))
; hConsoleOutput : HANDLE -> "sptr"
; lpBuffer : CHAR_INFO* -> "sptr"
; dwBufferSize : COORD -> "int"
; dwBufferCoord : COORD -> "int"
; lpWriteRegion : SMALL_RECT* in/out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL WriteConsoleOutputA(HANDLE hConsoleOutput, CHAR_INFO* lpBuffer, COORD dwBufferSize, COORD dwBufferCoord, SMALL_RECT* lpWriteRegion)
#uselib "KERNEL32.dll"
#cfunc global WriteConsoleOutputA "WriteConsoleOutputA" intptr, var, int, int, var
; res = WriteConsoleOutputA(hConsoleOutput, lpBuffer, dwBufferSize, dwBufferCoord, lpWriteRegion)
; hConsoleOutput : HANDLE -> "intptr"
; lpBuffer : CHAR_INFO* -> "var"
; dwBufferSize : COORD -> "int"
; dwBufferCoord : COORD -> "int"
; lpWriteRegion : SMALL_RECT* in/out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL WriteConsoleOutputA(HANDLE hConsoleOutput, CHAR_INFO* lpBuffer, COORD dwBufferSize, COORD dwBufferCoord, SMALL_RECT* lpWriteRegion)
#uselib "KERNEL32.dll"
#cfunc global WriteConsoleOutputA "WriteConsoleOutputA" intptr, intptr, int, int, intptr
; res = WriteConsoleOutputA(hConsoleOutput, varptr(lpBuffer), dwBufferSize, dwBufferCoord, varptr(lpWriteRegion))
; hConsoleOutput : HANDLE -> "intptr"
; lpBuffer : CHAR_INFO* -> "intptr"
; dwBufferSize : COORD -> "int"
; dwBufferCoord : COORD -> "int"
; lpWriteRegion : SMALL_RECT* in/out -> "intptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWriteConsoleOutputA = kernel32.NewProc("WriteConsoleOutputA")
)

// hConsoleOutput (HANDLE), lpBuffer (CHAR_INFO*), dwBufferSize (COORD), dwBufferCoord (COORD), lpWriteRegion (SMALL_RECT* in/out)
r1, _, err := procWriteConsoleOutputA.Call(
	uintptr(hConsoleOutput),
	uintptr(lpBuffer),
	uintptr(dwBufferSize),
	uintptr(dwBufferCoord),
	uintptr(lpWriteRegion),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function WriteConsoleOutputA(
  hConsoleOutput: THandle;   // HANDLE
  lpBuffer: Pointer;   // CHAR_INFO*
  dwBufferSize: COORD;   // COORD
  dwBufferCoord: COORD;   // COORD
  lpWriteRegion: Pointer   // SMALL_RECT* in/out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WriteConsoleOutputA';

result := DllCall("KERNEL32\WriteConsoleOutputA"
    , "Ptr", hConsoleOutput   ; HANDLE
    , "Ptr", lpBuffer   ; CHAR_INFO*
    , "Ptr", dwBufferSize   ; COORD
    , "Ptr", dwBufferCoord   ; COORD
    , "Ptr", lpWriteRegion   ; SMALL_RECT* in/out
    , "Int")   ; return: BOOL

●WriteConsoleOutputA(hConsoleOutput, lpBuffer, dwBufferSize, dwBufferCoord, lpWriteRegion) = DLL("KERNEL32.dll", "bool WriteConsoleOutputA(void*, void*, void*, void*, void*)")
# 呼び出し: WriteConsoleOutputA(hConsoleOutput, lpBuffer, dwBufferSize, dwBufferCoord, lpWriteRegion)
# hConsoleOutput : HANDLE -> "void*"
# lpBuffer : CHAR_INFO* -> "void*"
# dwBufferSize : COORD -> "void*"
# dwBufferCoord : COORD -> "void*"
# lpWriteRegion : SMALL_RECT* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。