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

GetConsoleDisplayMode

関数
コンソールの表示モード(全画面など)を取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL GetConsoleDisplayMode(
    DWORD* lpModeFlags
);

パラメーター

名前型方向説明
lpModeFlagsDWORD*out現在の表示モード(全画面/ウィンドウ等)を示すフラグを受け取る出力DWORDポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

GetConsoleDisplayMode = ctypes.windll.kernel32.GetConsoleDisplayMode
GetConsoleDisplayMode.restype = wintypes.BOOL
GetConsoleDisplayMode.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # lpModeFlags : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetConsoleDisplayMode = Fiddle::Function.new(
  lib['GetConsoleDisplayMode'],
  [
    Fiddle::TYPE_VOIDP,  # lpModeFlags : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetConsoleDisplayMode(
        lpModeFlags: *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 GetConsoleDisplayMode(out uint lpModeFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetConsoleDisplayMode' -Namespace Win32 -PassThru
# $api::GetConsoleDisplayMode(lpModeFlags)
#uselib "KERNEL32.dll"
#func global GetConsoleDisplayMode "GetConsoleDisplayMode" sptr
; GetConsoleDisplayMode varptr(lpModeFlags)   ; 戻り値は stat
; lpModeFlags : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "KERNEL32.dll"
#cfunc global GetConsoleDisplayMode "GetConsoleDisplayMode" var
; res = GetConsoleDisplayMode(lpModeFlags)
; lpModeFlags : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; BOOL GetConsoleDisplayMode(DWORD* lpModeFlags)
#uselib "KERNEL32.dll"
#cfunc global GetConsoleDisplayMode "GetConsoleDisplayMode" var
; res = GetConsoleDisplayMode(lpModeFlags)
; lpModeFlags : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetConsoleDisplayMode = kernel32.NewProc("GetConsoleDisplayMode")
)

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

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

foreign import stdcall safe "GetConsoleDisplayMode"
  c_GetConsoleDisplayMode :: Ptr Word32 -> IO CInt
-- lpModeFlags : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getconsoledisplaymode =
  foreign "GetConsoleDisplayMode"
    ((ptr uint32_t) @-> returning int32_t)
(* lpModeFlags : 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 ("GetConsoleDisplayMode" get-console-display-mode :convention :stdcall) :int32
  (lp-mode-flags :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetConsoleDisplayMode = Win32::API::More->new('KERNEL32',
    'BOOL GetConsoleDisplayMode(LPVOID lpModeFlags)');
# my $ret = $GetConsoleDisplayMode->Call($lpModeFlags);
# lpModeFlags : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。