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

WriteConsoleOutputCharacterA

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

シグネチャ

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

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

パラメーター

名前方向
hConsoleOutputHANDLEin
lpCharacterLPCSTRin
nLengthDWORDin
dwWriteCoordCOORDin
lpNumberOfCharsWrittenDWORD*out

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