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

GetConsoleMode

関数
指定したコンソールハンドルの現在の入出力モードを取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL GetConsoleMode(
    HANDLE hConsoleHandle,
    CONSOLE_MODE* lpMode
);

パラメーター

名前方向
hConsoleHandleHANDLEin
lpModeCONSOLE_MODE*out

戻り値の型: BOOL

各言語での呼び出し定義

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

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

GetConsoleMode = ctypes.windll.kernel32.GetConsoleMode
GetConsoleMode.restype = wintypes.BOOL
GetConsoleMode.argtypes = [
    wintypes.HANDLE,  # hConsoleHandle : HANDLE
    ctypes.c_void_p,  # lpMode : CONSOLE_MODE* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetConsoleMode = Fiddle::Function.new(
  lib['GetConsoleMode'],
  [
    Fiddle::TYPE_VOIDP,  # hConsoleHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # lpMode : CONSOLE_MODE* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetConsoleMode(
        hConsoleHandle: *mut core::ffi::c_void,  // HANDLE
        lpMode: *mut u32  // CONSOLE_MODE* 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 GetConsoleMode(IntPtr hConsoleHandle, out uint lpMode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetConsoleMode' -Namespace Win32 -PassThru
# $api::GetConsoleMode(hConsoleHandle, lpMode)
#uselib "KERNEL32.dll"
#func global GetConsoleMode "GetConsoleMode" sptr, sptr
; GetConsoleMode hConsoleHandle, lpMode   ; 戻り値は stat
; hConsoleHandle : HANDLE -> "sptr"
; lpMode : CONSOLE_MODE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global GetConsoleMode "GetConsoleMode" sptr, int
; res = GetConsoleMode(hConsoleHandle, lpMode)
; hConsoleHandle : HANDLE -> "sptr"
; lpMode : CONSOLE_MODE* out -> "int"
; BOOL GetConsoleMode(HANDLE hConsoleHandle, CONSOLE_MODE* lpMode)
#uselib "KERNEL32.dll"
#cfunc global GetConsoleMode "GetConsoleMode" intptr, int
; res = GetConsoleMode(hConsoleHandle, lpMode)
; hConsoleHandle : HANDLE -> "intptr"
; lpMode : CONSOLE_MODE* out -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetConsoleMode = kernel32.NewProc("GetConsoleMode")
)

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