ホーム › System.Console › GetConsoleMode
GetConsoleMode
関数指定したコンソールハンドルの現在の入出力モードを取得する。
シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL GetConsoleMode(
HANDLE hConsoleHandle,
CONSOLE_MODE* lpMode
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hConsoleHandle | HANDLE | in | モードを取得する対象のコンソール入力または出力バッファのハンドル。 |
| lpMode | CONSOLE_MODE* | out | 現在のコンソールモードフラグを受け取るCONSOLE_MODE出力ポインタ。 |
戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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, varptr(lpMode) ; 戻り値は stat
; hConsoleHandle : HANDLE -> "sptr"
; lpMode : CONSOLE_MODE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "KERNEL32.dll" #cfunc global GetConsoleMode "GetConsoleMode" sptr, var ; res = GetConsoleMode(hConsoleHandle, lpMode) ; hConsoleHandle : HANDLE -> "sptr" ; lpMode : CONSOLE_MODE* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global GetConsoleMode "GetConsoleMode" sptr, sptr ; res = GetConsoleMode(hConsoleHandle, varptr(lpMode)) ; hConsoleHandle : HANDLE -> "sptr" ; lpMode : CONSOLE_MODE* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL GetConsoleMode(HANDLE hConsoleHandle, CONSOLE_MODE* lpMode) #uselib "KERNEL32.dll" #cfunc global GetConsoleMode "GetConsoleMode" intptr, var ; res = GetConsoleMode(hConsoleHandle, lpMode) ; hConsoleHandle : HANDLE -> "intptr" ; lpMode : CONSOLE_MODE* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL GetConsoleMode(HANDLE hConsoleHandle, CONSOLE_MODE* lpMode) #uselib "KERNEL32.dll" #cfunc global GetConsoleMode "GetConsoleMode" intptr, intptr ; res = GetConsoleMode(hConsoleHandle, varptr(lpMode)) ; hConsoleHandle : HANDLE -> "intptr" ; lpMode : CONSOLE_MODE* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
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 // BOOLfunction 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)。const std = @import("std");
extern "kernel32" fn GetConsoleMode(
hConsoleHandle: ?*anyopaque, // HANDLE
lpMode: [*c]u32 // CONSOLE_MODE* out
) callconv(std.os.windows.WINAPI) i32;proc GetConsoleMode(
hConsoleHandle: pointer, # HANDLE
lpMode: ptr uint32 # CONSOLE_MODE* out
): int32 {.importc: "GetConsoleMode", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int GetConsoleMode(
void* hConsoleHandle, // HANDLE
uint* lpMode // CONSOLE_MODE* out
);ccall((:GetConsoleMode, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{UInt32}),
hConsoleHandle, lpMode)
# hConsoleHandle : HANDLE -> Ptr{Cvoid}
# lpMode : CONSOLE_MODE* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t GetConsoleMode(
void* hConsoleHandle,
uint32_t* lpMode);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetConsoleMode(hConsoleHandle, lpMode)
-- hConsoleHandle : HANDLE
-- lpMode : CONSOLE_MODE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetConsoleMode = lib.func('__stdcall', 'GetConsoleMode', 'int32_t', ['void *', 'uint32_t *']);
// GetConsoleMode(hConsoleHandle, lpMode)
// hConsoleHandle : HANDLE -> 'void *'
// lpMode : CONSOLE_MODE* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
GetConsoleMode: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.GetConsoleMode(hConsoleHandle, lpMode)
// hConsoleHandle : HANDLE -> "pointer"
// lpMode : CONSOLE_MODE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t GetConsoleMode(
void* hConsoleHandle,
uint32_t* lpMode);
C, "KERNEL32.dll");
// $ffi->GetConsoleMode(hConsoleHandle, lpMode);
// hConsoleHandle : HANDLE
// lpMode : CONSOLE_MODE* 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 GetConsoleMode(
Pointer hConsoleHandle, // HANDLE
IntByReference lpMode // CONSOLE_MODE* out
);
}@[Link("kernel32")]
lib LibKERNEL32
fun GetConsoleMode = GetConsoleMode(
hConsoleHandle : Void*, # HANDLE
lpMode : UInt32* # CONSOLE_MODE* out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GetConsoleModeNative = Int32 Function(Pointer<Void>, Pointer<Uint32>);
typedef GetConsoleModeDart = int Function(Pointer<Void>, Pointer<Uint32>);
final GetConsoleMode = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<GetConsoleModeNative, GetConsoleModeDart>('GetConsoleMode');
// hConsoleHandle : HANDLE -> Pointer<Void>
// lpMode : CONSOLE_MODE* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetConsoleMode(
hConsoleHandle: THandle; // HANDLE
lpMode: Pointer // CONSOLE_MODE* out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'GetConsoleMode';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetConsoleMode"
c_GetConsoleMode :: Ptr () -> Ptr Word32 -> IO CInt
-- hConsoleHandle : HANDLE -> Ptr ()
-- lpMode : CONSOLE_MODE* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getconsolemode =
foreign "GetConsoleMode"
((ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* hConsoleHandle : HANDLE -> (ptr void) *)
(* lpMode : CONSOLE_MODE* 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 ("GetConsoleMode" get-console-mode :convention :stdcall) :int32
(h-console-handle :pointer) ; HANDLE
(lp-mode :pointer)) ; CONSOLE_MODE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetConsoleMode = Win32::API::More->new('KERNEL32',
'BOOL GetConsoleMode(HANDLE hConsoleHandle, LPVOID lpMode)');
# my $ret = $GetConsoleMode->Call($hConsoleHandle, $lpMode);
# hConsoleHandle : HANDLE -> HANDLE
# lpMode : CONSOLE_MODE* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
使用する型