Win32 API 日本語リファレンス
ホームUI.Shell › RegisterScaleChangeEvent

RegisterScaleChangeEvent

関数
スケール変更時にシグナルされるイベントを登録する。
DLLapi-ms-win-shcore-scaling-l1-1-1.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

// api-ms-win-shcore-scaling-l1-1-1.dll
#include <windows.h>

HRESULT RegisterScaleChangeEvent(
    HANDLE hEvent,
    UINT_PTR* pdwCookie
);

パラメーター

名前方向説明
hEventHANDLEinスケール変更通知を登録するイベントのハンドル。
pdwCookieUINT_PTR*outこの関数が正常に終了すると、この値は、後で UnregisterScaleChangeEvent を通じてスケール変更通知の登録を解除するために使用できる Cookie へのポインターのアドレスを受け取ります。

戻り値の型: HRESULT

公式ドキュメント

スケールが変更された可能性がある場合にトリガーされるイベントを登録します。この関数は RegisterScaleChangeNotifications を置き換えます。

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このイベントは、スケールに影響を与える可能性のある何かが発生するたびに発生しますが、スケールが影響を受ける可能性があるというだけで、実際に変更されたとは限りません。呼び出し元はスケール係数をキャッシュしておき、モニターのスケールが実際に変更されたかどうかを確認できます。イベントハンドルは複製されるため、呼び出し元はいつでも自身のハンドルを閉じることができます。

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

各言語での呼び出し定義

// api-ms-win-shcore-scaling-l1-1-1.dll
#include <windows.h>

HRESULT RegisterScaleChangeEvent(
    HANDLE hEvent,
    UINT_PTR* pdwCookie
);
[DllImport("api-ms-win-shcore-scaling-l1-1-1.dll", ExactSpelling = true)]
static extern int RegisterScaleChangeEvent(
    IntPtr hEvent,   // HANDLE
    out UIntPtr pdwCookie   // UINT_PTR* out
);
<DllImport("api-ms-win-shcore-scaling-l1-1-1.dll", ExactSpelling:=True)>
Public Shared Function RegisterScaleChangeEvent(
    hEvent As IntPtr,   ' HANDLE
    <Out> ByRef pdwCookie As UIntPtr   ' UINT_PTR* out
) As Integer
End Function
' hEvent : HANDLE
' pdwCookie : UINT_PTR* out
Declare PtrSafe Function RegisterScaleChangeEvent Lib "api-ms-win-shcore-scaling-l1-1-1" ( _
    ByVal hEvent As LongPtr, _
    ByRef pdwCookie As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RegisterScaleChangeEvent = ctypes.windll.LoadLibrary("api-ms-win-shcore-scaling-l1-1-1.dll").RegisterScaleChangeEvent
RegisterScaleChangeEvent.restype = ctypes.c_int
RegisterScaleChangeEvent.argtypes = [
    wintypes.HANDLE,  # hEvent : HANDLE
    ctypes.POINTER(ctypes.c_size_t),  # pdwCookie : UINT_PTR* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	api_ms_win_shcore_scaling_l1_1_1 = windows.NewLazySystemDLL("api-ms-win-shcore-scaling-l1-1-1.dll")
	procRegisterScaleChangeEvent = api_ms_win_shcore_scaling_l1_1_1.NewProc("RegisterScaleChangeEvent")
)

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

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

typedef RegisterScaleChangeEventNative = Int32 Function(Pointer<Void>, Pointer<UintPtr>);
typedef RegisterScaleChangeEventDart = int Function(Pointer<Void>, Pointer<UintPtr>);
final RegisterScaleChangeEvent = DynamicLibrary.open('api-ms-win-shcore-scaling-l1-1-1.dll')
    .lookupFunction<RegisterScaleChangeEventNative, RegisterScaleChangeEventDart>('RegisterScaleChangeEvent');
// hEvent : HANDLE -> Pointer<Void>
// pdwCookie : UINT_PTR* out -> Pointer<UintPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RegisterScaleChangeEvent(
  hEvent: THandle;   // HANDLE
  pdwCookie: Pointer   // UINT_PTR* out
): Integer; stdcall;
  external 'api-ms-win-shcore-scaling-l1-1-1.dll' name 'RegisterScaleChangeEvent';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let registerscalechangeevent =
  foreign "RegisterScaleChangeEvent"
    ((ptr void) @-> (ptr size_t) @-> returning int32_t)
(* hEvent : HANDLE -> (ptr void) *)
(* pdwCookie : UINT_PTR* out -> (ptr size_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library api-ms-win-shcore-scaling-l1-1-1 (t "api-ms-win-shcore-scaling-l1-1-1.dll"))
(cffi:use-foreign-library api-ms-win-shcore-scaling-l1-1-1)

(cffi:defcfun ("RegisterScaleChangeEvent" register-scale-change-event :convention :stdcall) :int32
  (h-event :pointer)   ; HANDLE
  (pdw-cookie :pointer))   ; UINT_PTR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RegisterScaleChangeEvent = Win32::API::More->new('api-ms-win-shcore-scaling-l1-1-1',
    'int RegisterScaleChangeEvent(HANDLE hEvent, LPVOID pdwCookie)');
# my $ret = $RegisterScaleChangeEvent->Call($hEvent, $pdwCookie);
# hEvent : HANDLE -> HANDLE
# pdwCookie : UINT_PTR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目