GetSystemMetrics
関数シグネチャ
// USER32.dll
#include <windows.h>
INT GetSystemMetrics(
SYSTEM_METRICS_INDEX nIndex
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| nIndex | SYSTEM_METRICS_INDEX | in | 取得するシステムメトリックまたは構成設定です。このパラメーターには、次のいずれかの値を指定できます。 すべての SM_CX* 値は幅、すべての SM_CY* 値は高さである点に注意してください。また、ブール値のデータを返すよう設計されたすべての設定では、TRUE は 0 以外の任意の値、FALSE は 0 で表されます。
|
戻り値の型: INT
公式ドキュメント
指定されたシステムメトリックまたはシステム構成設定を取得します。
戻り値
解説(Remarks)
システムメトリックはディスプレイごとに異なる場合があります。
GetSystemMetrics(SM_CMONITORS) は、可視のディスプレイモニターのみを数えます。これは、可視のディスプレイモニターと、ミラーリングドライバーに関連付けられた不可視の疑似モニターの両方を列挙する EnumDisplayMonitors とは異なります。不可視の疑似モニターは、リモート処理などの目的でアプリケーションの描画をミラーリングするために使用される疑似デバイスに関連付けられています。
SM_ARRANGE 設定は、システムが最小化されたウィンドウをどのように配置するかを指定し、開始位置と方向で構成されます。開始位置には次のいずれかの値を指定できます。
| 値 | 意味 |
|---|---|
| ARW_BOTTOMLEFT | 画面の左下隅から開始します。既定の位置です。 |
| ARW_BOTTOMRIGHT | 画面の右下隅から開始します。ARW_STARTRIGHT と同等です。 |
| ARW_TOPLEFT | 画面の左上隅から開始します。ARW_STARTTOP と同等です。 |
| ARW_TOPRIGHT | 画面の右上隅から開始します。ARW_STARTTOP | SRW_STARTRIGHT と同等です。 |
最小化されたウィンドウを配置する方向には、次のいずれかの値を指定できます。
| 値 | 意味 |
|---|---|
| ARW_DOWN | 垂直方向に、上から下へ配置します。 |
| ARW_HIDE | 最小化されたウィンドウを画面の可視領域外へ移動して非表示にします。 |
| ARW_LEFT | 水平方向に、左から右へ配置します。 |
| ARW_RIGHT | 水平方向に、右から左へ配置します。 |
| ARW_UP | 垂直方向に、下から上へ配置します。 |
SM_DIGITIZER 設定は、Windows 7 または Windows Server 2008 R2 を実行するデバイスにインストールされているデジタイザーの種類を指定します。戻り値は、次の値の 1 つ以上を指定するビットマスクです。
| 値 | 意味 |
|---|---|
|
NID_INTEGRATED_TOUCH
0x01 |
デバイスは内蔵タッチデジタイザーを備えています。 |
|
NID_EXTERNAL_TOUCH
0x02 |
デバイスは外付けタッチデジタイザーを備えています。 |
|
NID_INTEGRATED_PEN
0x04 |
デバイスは内蔵ペンデジタイザーを備えています。 |
|
NID_EXTERNAL_PEN
0x08 |
デバイスは外付けペンデジタイザーを備えています。 |
|
NID_MULTI_INPUT
0x40 |
デバイスは複数のデジタイザー入力ソースをサポートしています。 |
|
NID_READY
0x80 |
デバイスはデジタイザー入力を受け取る準備ができています。 |
この API は DPI を認識しないため、呼び出し元のスレッドがモニターごとの DPI を認識する場合は使用しないでください。この API の DPI 対応版については、GetSystemMetricsForDPI を参照してください。DPI 認識の詳細については、Windows の高 DPI ドキュメントを参照してください。
例
次の例では、GetSystemMetrics 関数を使用して、マウスがインストールされているか、およびマウスボタンが入れ替えられているかを判定します。また、SystemParametersInfo 関数を使用してマウスのしきい値と速度を取得します。情報はコンソールに表示されます。
#include <windows.h>
#include <stdio.h>
#pragma comment(lib, "user32.lib")
void main()
{
BOOL fResult;
int aMouseInfo[3];
fResult = GetSystemMetrics(SM_MOUSEPRESENT);
if (fResult == 0)
printf("No mouse installed.\n");
else
{
printf("Mouse installed.\n");
// Determine whether the buttons are swapped.
fResult = GetSystemMetrics(SM_SWAPBUTTON);
if (fResult == 0)
printf("Buttons not swapped.\n");
else printf("Buttons swapped.\n");
// Get the mouse speed and the threshold values.
fResult = SystemParametersInfo(
SPI_GETMOUSE, // get mouse information
0, // not used
&aMouseInfo, // holds mouse information
0); // not used
if( fResult )
{
printf("Speed: %d\n", aMouseInfo[2]);
printf("Threshold (x,y): %d,%d\n",
aMouseInfo[0], aMouseInfo[1]);
}
}
}
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll
#include <windows.h>
INT GetSystemMetrics(
SYSTEM_METRICS_INDEX nIndex
);[DllImport("USER32.dll", ExactSpelling = true)]
static extern int GetSystemMetrics(
int nIndex // SYSTEM_METRICS_INDEX
);<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function GetSystemMetrics(
nIndex As Integer ' SYSTEM_METRICS_INDEX
) As Integer
End Function' nIndex : SYSTEM_METRICS_INDEX
Declare PtrSafe Function GetSystemMetrics Lib "user32" ( _
ByVal nIndex As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
GetSystemMetrics = ctypes.windll.user32.GetSystemMetrics
GetSystemMetrics.restype = ctypes.c_int
GetSystemMetrics.argtypes = [
ctypes.c_int, # nIndex : SYSTEM_METRICS_INDEX
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('USER32.dll')
GetSystemMetrics = Fiddle::Function.new(
lib['GetSystemMetrics'],
[
Fiddle::TYPE_INT, # nIndex : SYSTEM_METRICS_INDEX
],
Fiddle::TYPE_INT)#[link(name = "user32")]
extern "system" {
fn GetSystemMetrics(
nIndex: i32 // SYSTEM_METRICS_INDEX
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("USER32.dll")]
public static extern int GetSystemMetrics(int nIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetSystemMetrics' -Namespace Win32 -PassThru
# $api::GetSystemMetrics(nIndex)#uselib "USER32.dll"
#func global GetSystemMetrics "GetSystemMetrics" sptr
; GetSystemMetrics nIndex ; 戻り値は stat
; nIndex : SYSTEM_METRICS_INDEX -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global GetSystemMetrics "GetSystemMetrics" int
; res = GetSystemMetrics(nIndex)
; nIndex : SYSTEM_METRICS_INDEX -> "int"; INT GetSystemMetrics(SYSTEM_METRICS_INDEX nIndex)
#uselib "USER32.dll"
#cfunc global GetSystemMetrics "GetSystemMetrics" int
; res = GetSystemMetrics(nIndex)
; nIndex : SYSTEM_METRICS_INDEX -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procGetSystemMetrics = user32.NewProc("GetSystemMetrics")
)
// nIndex (SYSTEM_METRICS_INDEX)
r1, _, err := procGetSystemMetrics.Call(
uintptr(nIndex),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction GetSystemMetrics(
nIndex: Integer // SYSTEM_METRICS_INDEX
): Integer; stdcall;
external 'USER32.dll' name 'GetSystemMetrics';result := DllCall("USER32\GetSystemMetrics"
, "Int", nIndex ; SYSTEM_METRICS_INDEX
, "Int") ; return: INT●GetSystemMetrics(nIndex) = DLL("USER32.dll", "int GetSystemMetrics(int)")
# 呼び出し: GetSystemMetrics(nIndex)
# nIndex : SYSTEM_METRICS_INDEX -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "user32" fn GetSystemMetrics(
nIndex: i32 // SYSTEM_METRICS_INDEX
) callconv(std.os.windows.WINAPI) i32;proc GetSystemMetrics(
nIndex: int32 # SYSTEM_METRICS_INDEX
): int32 {.importc: "GetSystemMetrics", stdcall, dynlib: "USER32.dll".}pragma(lib, "user32");
extern(Windows)
int GetSystemMetrics(
int nIndex // SYSTEM_METRICS_INDEX
);ccall((:GetSystemMetrics, "USER32.dll"), stdcall, Int32,
(Int32,),
nIndex)
# nIndex : SYSTEM_METRICS_INDEX -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t GetSystemMetrics(
int32_t nIndex);
]]
local user32 = ffi.load("user32")
-- user32.GetSystemMetrics(nIndex)
-- nIndex : SYSTEM_METRICS_INDEX
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetSystemMetrics = lib.func('__stdcall', 'GetSystemMetrics', 'int32_t', ['int32_t']);
// GetSystemMetrics(nIndex)
// nIndex : SYSTEM_METRICS_INDEX -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
GetSystemMetrics: { parameters: ["i32"], result: "i32" },
});
// lib.symbols.GetSystemMetrics(nIndex)
// nIndex : SYSTEM_METRICS_INDEX -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t GetSystemMetrics(
int32_t nIndex);
C, "USER32.dll");
// $ffi->GetSystemMetrics(nIndex);
// nIndex : SYSTEM_METRICS_INDEX
// 構造体/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 User32 extends StdCallLibrary {
User32 INSTANCE = Native.load("user32", User32.class);
int GetSystemMetrics(
int nIndex // SYSTEM_METRICS_INDEX
);
}@[Link("user32")]
lib LibUSER32
fun GetSystemMetrics = GetSystemMetrics(
nIndex : Int32 # SYSTEM_METRICS_INDEX
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GetSystemMetricsNative = Int32 Function(Int32);
typedef GetSystemMetricsDart = int Function(int);
final GetSystemMetrics = DynamicLibrary.open('USER32.dll')
.lookupFunction<GetSystemMetricsNative, GetSystemMetricsDart>('GetSystemMetrics');
// nIndex : SYSTEM_METRICS_INDEX -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetSystemMetrics(
nIndex: Integer // SYSTEM_METRICS_INDEX
): Integer; stdcall;
external 'USER32.dll' name 'GetSystemMetrics';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetSystemMetrics"
c_GetSystemMetrics :: Int32 -> IO Int32
-- nIndex : SYSTEM_METRICS_INDEX -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getsystemmetrics =
foreign "GetSystemMetrics"
(int32_t @-> returning int32_t)
(* nIndex : SYSTEM_METRICS_INDEX -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)
(cffi:defcfun ("GetSystemMetrics" get-system-metrics :convention :stdcall) :int32
(n-index :int32)) ; SYSTEM_METRICS_INDEX
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetSystemMetrics = Win32::API::More->new('USER32',
'int GetSystemMetrics(int nIndex)');
# my $ret = $GetSystemMetrics->Call($nIndex);
# nIndex : SYSTEM_METRICS_INDEX -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f EnumDisplayMonitors — 表示モニタの集合をコールバックで列挙する。
- f GetSystemMetricsForDpi — 指定DPIに対応したシステムメトリクス値を取得する。
- f SystemParametersInfoW — システム全体のパラメータを取得または設定する(Unicode版)。