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

WriteConsoleOutputAttribute

関数
コンソール画面バッファの指定座標から属性値を連続して書き込む。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり
📘 Microsoft Learn (日本語) · English

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL WriteConsoleOutputAttribute(
    HANDLE hConsoleOutput,
    const WORD* lpAttribute,
    DWORD nLength,
    COORD dwWriteCoord,
    DWORD* lpNumberOfAttrsWritten
);

パラメーター

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

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

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

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

lib = Fiddle.dlopen('KERNEL32.dll')
WriteConsoleOutputAttribute = Fiddle::Function.new(
  lib['WriteConsoleOutputAttribute'],
  [
    Fiddle::TYPE_VOIDP,  # hConsoleOutput : HANDLE
    Fiddle::TYPE_VOIDP,  # lpAttribute : WORD*
    -Fiddle::TYPE_INT,  # nLength : DWORD
    Fiddle::TYPE_VOIDP,  # dwWriteCoord : COORD
    Fiddle::TYPE_VOIDP,  # lpNumberOfAttrsWritten : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn WriteConsoleOutputAttribute(
        hConsoleOutput: *mut core::ffi::c_void,  // HANDLE
        lpAttribute: *const u16,  // WORD*
        nLength: u32,  // DWORD
        dwWriteCoord: COORD,  // COORD
        lpNumberOfAttrsWritten: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool WriteConsoleOutputAttribute(IntPtr hConsoleOutput, ref ushort lpAttribute, uint nLength, COORD dwWriteCoord, out uint lpNumberOfAttrsWritten);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_WriteConsoleOutputAttribute' -Namespace Win32 -PassThru
# $api::WriteConsoleOutputAttribute(hConsoleOutput, lpAttribute, nLength, dwWriteCoord, lpNumberOfAttrsWritten)
#uselib "KERNEL32.dll"
#func global WriteConsoleOutputAttribute "WriteConsoleOutputAttribute" sptr, sptr, sptr, sptr, sptr
; WriteConsoleOutputAttribute hConsoleOutput, varptr(lpAttribute), nLength, dwWriteCoord, varptr(lpNumberOfAttrsWritten)   ; 戻り値は stat
; hConsoleOutput : HANDLE -> "sptr"
; lpAttribute : WORD* -> "sptr"
; nLength : DWORD -> "sptr"
; dwWriteCoord : COORD -> "sptr"
; lpNumberOfAttrsWritten : DWORD* out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "KERNEL32.dll"
#cfunc global WriteConsoleOutputAttribute "WriteConsoleOutputAttribute" sptr, var, int, int, var
; res = WriteConsoleOutputAttribute(hConsoleOutput, lpAttribute, nLength, dwWriteCoord, lpNumberOfAttrsWritten)
; hConsoleOutput : HANDLE -> "sptr"
; lpAttribute : WORD* -> "var"
; nLength : DWORD -> "int"
; dwWriteCoord : COORD -> "int"
; lpNumberOfAttrsWritten : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; BOOL WriteConsoleOutputAttribute(HANDLE hConsoleOutput, WORD* lpAttribute, DWORD nLength, COORD dwWriteCoord, DWORD* lpNumberOfAttrsWritten)
#uselib "KERNEL32.dll"
#cfunc global WriteConsoleOutputAttribute "WriteConsoleOutputAttribute" intptr, var, int, int, var
; res = WriteConsoleOutputAttribute(hConsoleOutput, lpAttribute, nLength, dwWriteCoord, lpNumberOfAttrsWritten)
; hConsoleOutput : HANDLE -> "intptr"
; lpAttribute : WORD* -> "var"
; nLength : DWORD -> "int"
; dwWriteCoord : COORD -> "int"
; lpNumberOfAttrsWritten : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWriteConsoleOutputAttribute = kernel32.NewProc("WriteConsoleOutputAttribute")
)

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

extern "kernel32" fn WriteConsoleOutputAttribute(
    hConsoleOutput: ?*anyopaque, // HANDLE
    lpAttribute: [*c]u16, // WORD*
    nLength: u32, // DWORD
    dwWriteCoord: COORD, // COORD
    lpNumberOfAttrsWritten: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
proc WriteConsoleOutputAttribute(
    hConsoleOutput: pointer,  # HANDLE
    lpAttribute: ptr uint16,  # WORD*
    nLength: uint32,  # DWORD
    dwWriteCoord: COORD,  # COORD
    lpNumberOfAttrsWritten: ptr uint32  # DWORD* out
): int32 {.importc: "WriteConsoleOutputAttribute", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int WriteConsoleOutputAttribute(
    void* hConsoleOutput,   // HANDLE
    ushort* lpAttribute,   // WORD*
    uint nLength,   // DWORD
    COORD dwWriteCoord,   // COORD
    uint* lpNumberOfAttrsWritten   // DWORD* out
);
ccall((:WriteConsoleOutputAttribute, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{UInt16}, UInt32, COORD, Ptr{UInt32}),
      hConsoleOutput, lpAttribute, nLength, dwWriteCoord, lpNumberOfAttrsWritten)
# hConsoleOutput : HANDLE -> Ptr{Cvoid}
# lpAttribute : WORD* -> Ptr{UInt16}
# nLength : DWORD -> UInt32
# dwWriteCoord : COORD -> COORD
# lpNumberOfAttrsWritten : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WriteConsoleOutputAttribute(
    void* hConsoleOutput,
    uint16_t* lpAttribute,
    uint32_t nLength,
    COORD dwWriteCoord,
    uint32_t* lpNumberOfAttrsWritten);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.WriteConsoleOutputAttribute(hConsoleOutput, lpAttribute, nLength, dwWriteCoord, lpNumberOfAttrsWritten)
-- hConsoleOutput : HANDLE
-- lpAttribute : WORD*
-- nLength : DWORD
-- dwWriteCoord : COORD
-- lpNumberOfAttrsWritten : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const WriteConsoleOutputAttribute = lib.func('__stdcall', 'WriteConsoleOutputAttribute', 'int32_t', ['void *', 'uint16_t *', 'uint32_t', 'COORD', 'uint32_t *']);
// WriteConsoleOutputAttribute(hConsoleOutput, lpAttribute, nLength, dwWriteCoord, lpNumberOfAttrsWritten)
// hConsoleOutput : HANDLE -> 'void *'
// lpAttribute : WORD* -> 'uint16_t *'
// nLength : DWORD -> 'uint32_t'
// dwWriteCoord : COORD -> 'COORD'
// lpNumberOfAttrsWritten : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  WriteConsoleOutputAttribute: { parameters: ["pointer", "pointer", "u32", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.WriteConsoleOutputAttribute(hConsoleOutput, lpAttribute, nLength, dwWriteCoord, lpNumberOfAttrsWritten)
// hConsoleOutput : HANDLE -> "pointer"
// lpAttribute : WORD* -> "pointer"
// nLength : DWORD -> "u32"
// dwWriteCoord : COORD -> "buffer"
// lpNumberOfAttrsWritten : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WriteConsoleOutputAttribute(
    void* hConsoleOutput,
    uint16_t* lpAttribute,
    uint32_t nLength,
    COORD dwWriteCoord,
    uint32_t* lpNumberOfAttrsWritten);
C, "KERNEL32.dll");
// $ffi->WriteConsoleOutputAttribute(hConsoleOutput, lpAttribute, nLength, dwWriteCoord, lpNumberOfAttrsWritten);
// hConsoleOutput : HANDLE
// lpAttribute : WORD*
// nLength : DWORD
// dwWriteCoord : COORD
// lpNumberOfAttrsWritten : 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);
    boolean WriteConsoleOutputAttribute(
        Pointer hConsoleOutput,   // HANDLE
        ShortByReference lpAttribute,   // WORD*
        int nLength,   // DWORD
        COORD /* extends Structure (by value) */ dwWriteCoord,   // COORD
        IntByReference lpNumberOfAttrsWritten   // DWORD* out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun WriteConsoleOutputAttribute = WriteConsoleOutputAttribute(
    hConsoleOutput : Void*,   # HANDLE
    lpAttribute : UInt16*,   # WORD*
    nLength : UInt32,   # DWORD
    dwWriteCoord : COORD,   # COORD
    lpNumberOfAttrsWritten : 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 WriteConsoleOutputAttributeNative = Int32 Function(Pointer<Void>, Pointer<Uint16>, Uint32, COORD, Pointer<Uint32>);
typedef WriteConsoleOutputAttributeDart = int Function(Pointer<Void>, Pointer<Uint16>, int, int, Pointer<Uint32>);
final WriteConsoleOutputAttribute = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<WriteConsoleOutputAttributeNative, WriteConsoleOutputAttributeDart>('WriteConsoleOutputAttribute');
// hConsoleOutput : HANDLE -> Pointer<Void>
// lpAttribute : WORD* -> Pointer<Uint16>
// nLength : DWORD -> Uint32
// dwWriteCoord : COORD -> COORD
// lpNumberOfAttrsWritten : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WriteConsoleOutputAttribute(
  hConsoleOutput: THandle;   // HANDLE
  lpAttribute: Pointer;   // WORD*
  nLength: DWORD;   // DWORD
  dwWriteCoord: COORD;   // COORD
  lpNumberOfAttrsWritten: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WriteConsoleOutputAttribute';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let writeconsoleoutputattribute =
  foreign "WriteConsoleOutputAttribute"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> COORD @-> (ptr uint32_t) @-> returning int32_t)
(* hConsoleOutput : HANDLE -> (ptr void) *)
(* lpAttribute : WORD* -> (ptr uint16_t) *)
(* nLength : DWORD -> uint32_t *)
(* dwWriteCoord : COORD -> COORD *)
(* lpNumberOfAttrsWritten : 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 ("WriteConsoleOutputAttribute" write-console-output-attribute :convention :stdcall) :int32
  (h-console-output :pointer)   ; HANDLE
  (lp-attribute :pointer)   ; WORD*
  (n-length :uint32)   ; DWORD
  (dw-write-coord (:struct coord))   ; COORD
  (lp-number-of-attrs-written :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WriteConsoleOutputAttribute = Win32::API::More->new('KERNEL32',
    'BOOL WriteConsoleOutputAttribute(HANDLE hConsoleOutput, LPVOID lpAttribute, DWORD nLength, LPVOID dwWriteCoord, LPVOID lpNumberOfAttrsWritten)');
# my $ret = $WriteConsoleOutputAttribute->Call($hConsoleOutput, $lpAttribute, $nLength, $dwWriteCoord, $lpNumberOfAttrsWritten);
# hConsoleOutput : HANDLE -> HANDLE
# lpAttribute : WORD* -> LPVOID
# nLength : DWORD -> DWORD
# dwWriteCoord : COORD -> LPVOID
# lpNumberOfAttrsWritten : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型