Win32 API 日本語リファレンス
ホームDevices.Display › GetMonitorColorTemperature

GetMonitorColorTemperature

関数
モニタの現在の色温度を取得する。
DLLdxva2.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

INT GetMonitorColorTemperature(
    HANDLE hMonitor,
    MC_COLOR_TEMPERATURE* pctCurrentColorTemperature
);

パラメーター

名前方向説明
hMonitorHANDLEin物理モニターへのハンドルです。モニターハンドルを取得するには、GetPhysicalMonitorsFromHMONITOR または GetPhysicalMonitorsFromIDirect3DDevice9 を呼び出します。
pctCurrentColorTemperatureMC_COLOR_TEMPERATURE*outモニターの現在の色温度を受け取ります。MC_COLOR_TEMPERATURE 列挙体のメンバーとして指定されます。

戻り値の型: INT

公式ドキュメント

モニターの現在の色温度を取得します。

戻り値

関数が成功した場合、戻り値は TRUE です。関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

この関数がサポートされている場合、GetMonitorCapabilities 関数は MC_CAPS_COLOR_TEMPERATURE フラグを返します。

この関数は、戻るまでに 0 ~ 80 ミリ秒かかります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

INT GetMonitorColorTemperature(
    HANDLE hMonitor,
    MC_COLOR_TEMPERATURE* pctCurrentColorTemperature
);
[DllImport("dxva2.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetMonitorColorTemperature(
    IntPtr hMonitor,   // HANDLE
    out int pctCurrentColorTemperature   // MC_COLOR_TEMPERATURE* out
);
<DllImport("dxva2.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetMonitorColorTemperature(
    hMonitor As IntPtr,   ' HANDLE
    <Out> ByRef pctCurrentColorTemperature As Integer   ' MC_COLOR_TEMPERATURE* out
) As Integer
End Function
' hMonitor : HANDLE
' pctCurrentColorTemperature : MC_COLOR_TEMPERATURE* out
Declare PtrSafe Function GetMonitorColorTemperature Lib "dxva2" ( _
    ByVal hMonitor As LongPtr, _
    ByRef pctCurrentColorTemperature As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetMonitorColorTemperature = ctypes.windll.dxva2.GetMonitorColorTemperature
GetMonitorColorTemperature.restype = ctypes.c_int
GetMonitorColorTemperature.argtypes = [
    wintypes.HANDLE,  # hMonitor : HANDLE
    ctypes.c_void_p,  # pctCurrentColorTemperature : MC_COLOR_TEMPERATURE* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dxva2.dll')
GetMonitorColorTemperature = Fiddle::Function.new(
  lib['GetMonitorColorTemperature'],
  [
    Fiddle::TYPE_VOIDP,  # hMonitor : HANDLE
    Fiddle::TYPE_VOIDP,  # pctCurrentColorTemperature : MC_COLOR_TEMPERATURE* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "dxva2")]
extern "system" {
    fn GetMonitorColorTemperature(
        hMonitor: *mut core::ffi::c_void,  // HANDLE
        pctCurrentColorTemperature: *mut i32  // MC_COLOR_TEMPERATURE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("dxva2.dll", SetLastError = true)]
public static extern int GetMonitorColorTemperature(IntPtr hMonitor, out int pctCurrentColorTemperature);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dxva2_GetMonitorColorTemperature' -Namespace Win32 -PassThru
# $api::GetMonitorColorTemperature(hMonitor, pctCurrentColorTemperature)
#uselib "dxva2.dll"
#func global GetMonitorColorTemperature "GetMonitorColorTemperature" sptr, sptr
; GetMonitorColorTemperature hMonitor, varptr(pctCurrentColorTemperature)   ; 戻り値は stat
; hMonitor : HANDLE -> "sptr"
; pctCurrentColorTemperature : MC_COLOR_TEMPERATURE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dxva2.dll"
#cfunc global GetMonitorColorTemperature "GetMonitorColorTemperature" sptr, var
; res = GetMonitorColorTemperature(hMonitor, pctCurrentColorTemperature)
; hMonitor : HANDLE -> "sptr"
; pctCurrentColorTemperature : MC_COLOR_TEMPERATURE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT GetMonitorColorTemperature(HANDLE hMonitor, MC_COLOR_TEMPERATURE* pctCurrentColorTemperature)
#uselib "dxva2.dll"
#cfunc global GetMonitorColorTemperature "GetMonitorColorTemperature" intptr, var
; res = GetMonitorColorTemperature(hMonitor, pctCurrentColorTemperature)
; hMonitor : HANDLE -> "intptr"
; pctCurrentColorTemperature : MC_COLOR_TEMPERATURE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dxva2 = windows.NewLazySystemDLL("dxva2.dll")
	procGetMonitorColorTemperature = dxva2.NewProc("GetMonitorColorTemperature")
)

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

extern "dxva2" fn GetMonitorColorTemperature(
    hMonitor: ?*anyopaque, // HANDLE
    pctCurrentColorTemperature: [*c]i32 // MC_COLOR_TEMPERATURE* out
) callconv(std.os.windows.WINAPI) i32;
proc GetMonitorColorTemperature(
    hMonitor: pointer,  # HANDLE
    pctCurrentColorTemperature: ptr int32  # MC_COLOR_TEMPERATURE* out
): int32 {.importc: "GetMonitorColorTemperature", stdcall, dynlib: "dxva2.dll".}
pragma(lib, "dxva2");
extern(Windows)
int GetMonitorColorTemperature(
    void* hMonitor,   // HANDLE
    int* pctCurrentColorTemperature   // MC_COLOR_TEMPERATURE* out
);
ccall((:GetMonitorColorTemperature, "dxva2.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Int32}),
      hMonitor, pctCurrentColorTemperature)
# hMonitor : HANDLE -> Ptr{Cvoid}
# pctCurrentColorTemperature : MC_COLOR_TEMPERATURE* out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetMonitorColorTemperature(
    void* hMonitor,
    int32_t* pctCurrentColorTemperature);
]]
local dxva2 = ffi.load("dxva2")
-- dxva2.GetMonitorColorTemperature(hMonitor, pctCurrentColorTemperature)
-- hMonitor : HANDLE
-- pctCurrentColorTemperature : MC_COLOR_TEMPERATURE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dxva2.dll');
const GetMonitorColorTemperature = lib.func('__stdcall', 'GetMonitorColorTemperature', 'int32_t', ['void *', 'int32_t *']);
// GetMonitorColorTemperature(hMonitor, pctCurrentColorTemperature)
// hMonitor : HANDLE -> 'void *'
// pctCurrentColorTemperature : MC_COLOR_TEMPERATURE* out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dxva2.dll", {
  GetMonitorColorTemperature: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.GetMonitorColorTemperature(hMonitor, pctCurrentColorTemperature)
// hMonitor : HANDLE -> "pointer"
// pctCurrentColorTemperature : MC_COLOR_TEMPERATURE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetMonitorColorTemperature(
    void* hMonitor,
    int32_t* pctCurrentColorTemperature);
C, "dxva2.dll");
// $ffi->GetMonitorColorTemperature(hMonitor, pctCurrentColorTemperature);
// hMonitor : HANDLE
// pctCurrentColorTemperature : MC_COLOR_TEMPERATURE* 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 Dxva2 extends StdCallLibrary {
    Dxva2 INSTANCE = Native.load("dxva2", Dxva2.class);
    int GetMonitorColorTemperature(
        Pointer hMonitor,   // HANDLE
        IntByReference pctCurrentColorTemperature   // MC_COLOR_TEMPERATURE* out
    );
}
@[Link("dxva2")]
lib Libdxva2
  fun GetMonitorColorTemperature = GetMonitorColorTemperature(
    hMonitor : Void*,   # HANDLE
    pctCurrentColorTemperature : Int32*   # MC_COLOR_TEMPERATURE* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetMonitorColorTemperatureNative = Int32 Function(Pointer<Void>, Pointer<Int32>);
typedef GetMonitorColorTemperatureDart = int Function(Pointer<Void>, Pointer<Int32>);
final GetMonitorColorTemperature = DynamicLibrary.open('dxva2.dll')
    .lookupFunction<GetMonitorColorTemperatureNative, GetMonitorColorTemperatureDart>('GetMonitorColorTemperature');
// hMonitor : HANDLE -> Pointer<Void>
// pctCurrentColorTemperature : MC_COLOR_TEMPERATURE* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetMonitorColorTemperature(
  hMonitor: THandle;   // HANDLE
  pctCurrentColorTemperature: Pointer   // MC_COLOR_TEMPERATURE* out
): Integer; stdcall;
  external 'dxva2.dll' name 'GetMonitorColorTemperature';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetMonitorColorTemperature"
  c_GetMonitorColorTemperature :: Ptr () -> Ptr Int32 -> IO Int32
-- hMonitor : HANDLE -> Ptr ()
-- pctCurrentColorTemperature : MC_COLOR_TEMPERATURE* out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getmonitorcolortemperature =
  foreign "GetMonitorColorTemperature"
    ((ptr void) @-> (ptr int32_t) @-> returning int32_t)
(* hMonitor : HANDLE -> (ptr void) *)
(* pctCurrentColorTemperature : MC_COLOR_TEMPERATURE* out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dxva2 (t "dxva2.dll"))
(cffi:use-foreign-library dxva2)

(cffi:defcfun ("GetMonitorColorTemperature" get-monitor-color-temperature :convention :stdcall) :int32
  (h-monitor :pointer)   ; HANDLE
  (pct-current-color-temperature :pointer))   ; MC_COLOR_TEMPERATURE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetMonitorColorTemperature = Win32::API::More->new('dxva2',
    'int GetMonitorColorTemperature(HANDLE hMonitor, LPVOID pctCurrentColorTemperature)');
# my $ret = $GetMonitorColorTemperature->Call($hMonitor, $pctCurrentColorTemperature);
# hMonitor : HANDLE -> HANDLE
# pctCurrentColorTemperature : MC_COLOR_TEMPERATURE* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型