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

GetConsoleCharType

関数
コンソール画面の指定座標の文字種別を取得する内部関数。
DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

BOOL GetConsoleCharType(
    HANDLE hConsole,
    COORD coordCheck,
    DWORD* pdwType
);

パラメーター

名前方向説明
hConsoleHANDLEin対象コンソール画面バッファのハンドル。
coordCheckCOORDin判定対象とするセル位置(列・行)を示すCOORD値。
pdwTypeDWORD*out当該位置の文字種別(全角の先頭/末尾など)を示す値を受け取るDWORDポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

GetConsoleCharType = ctypes.windll.kernel32.GetConsoleCharType
GetConsoleCharType.restype = wintypes.BOOL
GetConsoleCharType.argtypes = [
    wintypes.HANDLE,  # hConsole : HANDLE
    COORD,  # coordCheck : COORD
    ctypes.POINTER(wintypes.DWORD),  # pdwType : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetConsoleCharType = kernel32.NewProc("GetConsoleCharType")
)

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

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

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

let getconsolechartype =
  foreign "GetConsoleCharType"
    ((ptr void) @-> COORD @-> (ptr uint32_t) @-> returning int32_t)
(* hConsole : HANDLE -> (ptr void) *)
(* coordCheck : COORD -> COORD *)
(* pdwType : 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 ("GetConsoleCharType" get-console-char-type :convention :stdcall) :int32
  (h-console :pointer)   ; HANDLE
  (coord-check (:struct coord))   ; COORD
  (pdw-type :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetConsoleCharType = Win32::API::More->new('KERNEL32',
    'BOOL GetConsoleCharType(HANDLE hConsole, LPVOID coordCheck, LPVOID pdwType)');
# my $ret = $GetConsoleCharType->Call($hConsole, $coordCheck, $pdwType);
# hConsole : HANDLE -> HANDLE
# coordCheck : COORD -> LPVOID
# pdwType : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型