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

ReadConsoleOutputAttribute

関数
コンソール画面バッファの指定座標から属性値を読み取る。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL ReadConsoleOutputAttribute(
    HANDLE hConsoleOutput,
    WORD* lpAttribute,
    DWORD nLength,
    COORD dwReadCoord,
    DWORD* lpNumberOfAttrsRead
);

パラメーター

名前方向
hConsoleOutputHANDLEin
lpAttributeWORD*out
nLengthDWORDin
dwReadCoordCOORDin
lpNumberOfAttrsReadDWORD*out

戻り値の型: BOOL

各言語での呼び出し定義

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

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procReadConsoleOutputAttribute = kernel32.NewProc("ReadConsoleOutputAttribute")
)

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