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
nNumberOfCharsToWriteDWORDin
lpNumberOfCharsWrittenDWORD*outoptional
lpReservedvoid*optional

戻り値の型: 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 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)。