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

SetProcessDpiAwareness

関数
プロセスのDPI認識レベルを設定する。
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 SetProcessDpiAwareness(
    PROCESS_DPI_AWARENESS value
);

パラメーター

名前型方向説明
valuePROCESS_DPI_AWARENESSin設定する DPI 認識値。指定できる値は PROCESS_DPI_AWARENESS 列挙型の値です。

戻り値の型: HRESULT

公式ドキュメント

プロセス既定の DPI 認識レベルを設定します。これは、対応する DPI_AWARENESS_CONTEXT 値を指定して SetProcessDpiAwarenessContext を呼び出すことと同等です。

戻り値

この関数は次のいずれかの値を返します。

戻り値 説明
S_OK
アプリの DPI 認識が正常に設定されました。
E_INVALIDARG
渡された値が有効ではありません。
E_ACCESSDENIED
DPI 認識は、以前にこの API を呼び出したか、またはアプリケーション (.exe) のマニフェストによって、すでに設定されています。

解説(Remarks)

以前のバージョンの Windows では、アプリケーション全体に対して DPI 認識値が 1 つしかありませんでした。そのようなアプリケーションでは、PROCESS_DPI_AWARENESS で説明されているとおり、マニフェストで DPI 認識値を設定することが推奨されていました。この推奨に従う場合、DPI 認識の更新に SetProcessDpiAwareness を使用することは想定されていませんでした。実際、DPI 認識が一度設定されると、この API への以降の呼び出しは失敗していました。現在では DPI 認識はアプリケーションではなくスレッドに紐付けられているため、このメソッドを使用して DPI 認識を更新できます。ただし、代わりに SetThreadDpiAwarenessContext の使用を検討してください。

重要

古いアプリケーションでは、アプリケーションの DPI 認識を設定するのに SetProcessDpiAwareness を使用しないことを強く推奨します。代わりに、アプリケーションマニフェストでアプリケーションの DPI 認識を宣言してください。DPI 認識値と、マニフェストでの設定方法の詳細については、PROCESS_DPI_AWARENESS を参照してください。

DPI 認識に依存する API を呼び出す前に、この API を呼び出す必要があります。これは、SetProcessDpiAwareness API ではなくアプリケーションマニフェストの使用が推奨される理由の 1 つでもあります。アプリの DPI 認識が一度設定されると、この API への以降の呼び出しはすべて失敗します。これは、マニフェストで DPI 認識を設定した場合でも、この API を使用して設定した場合でも同じです。

DPI 認識レベルが設定されていない場合、既定値は PROCESS_DPI_UNAWARE です。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SetProcessDpiAwareness(
    PROCESS_DPI_AWARENESS value
);
[DllImport("api-ms-win-shcore-scaling-l1-1-1.dll", ExactSpelling = true)]
static extern int SetProcessDpiAwareness(
    int value   // PROCESS_DPI_AWARENESS
);
<DllImport("api-ms-win-shcore-scaling-l1-1-1.dll", ExactSpelling:=True)>
Public Shared Function SetProcessDpiAwareness(
    value As Integer   ' PROCESS_DPI_AWARENESS
) As Integer
End Function
' value : PROCESS_DPI_AWARENESS
Declare PtrSafe Function SetProcessDpiAwareness Lib "api-ms-win-shcore-scaling-l1-1-1" ( _
    ByVal value As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetProcessDpiAwareness = ctypes.windll.LoadLibrary("api-ms-win-shcore-scaling-l1-1-1.dll").SetProcessDpiAwareness
SetProcessDpiAwareness.restype = ctypes.c_int
SetProcessDpiAwareness.argtypes = [
    ctypes.c_int,  # value : PROCESS_DPI_AWARENESS
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-shcore-scaling-l1-1-1.dll')
SetProcessDpiAwareness = Fiddle::Function.new(
  lib['SetProcessDpiAwareness'],
  [
    Fiddle::TYPE_INT,  # value : PROCESS_DPI_AWARENESS
  ],
  Fiddle::TYPE_INT)
#[link(name = "api-ms-win-shcore-scaling-l1-1-1")]
extern "system" {
    fn SetProcessDpiAwareness(
        value: i32  // PROCESS_DPI_AWARENESS
    ) -> 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 SetProcessDpiAwareness(int value);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-shcore-scaling-l1-1-1_SetProcessDpiAwareness' -Namespace Win32 -PassThru
# $api::SetProcessDpiAwareness(value)
#uselib "api-ms-win-shcore-scaling-l1-1-1.dll"
#func global SetProcessDpiAwareness "SetProcessDpiAwareness" sptr
; SetProcessDpiAwareness value   ; 戻り値は stat
; value : PROCESS_DPI_AWARENESS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "api-ms-win-shcore-scaling-l1-1-1.dll"
#cfunc global SetProcessDpiAwareness "SetProcessDpiAwareness" int
; res = SetProcessDpiAwareness(value)
; value : PROCESS_DPI_AWARENESS -> "int"
; HRESULT SetProcessDpiAwareness(PROCESS_DPI_AWARENESS value)
#uselib "api-ms-win-shcore-scaling-l1-1-1.dll"
#cfunc global SetProcessDpiAwareness "SetProcessDpiAwareness" int
; res = SetProcessDpiAwareness(value)
; value : PROCESS_DPI_AWARENESS -> "int"
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")
	procSetProcessDpiAwareness = api_ms_win_shcore_scaling_l1_1_1.NewProc("SetProcessDpiAwareness")
)

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

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

typedef SetProcessDpiAwarenessNative = Int32 Function(Int32);
typedef SetProcessDpiAwarenessDart = int Function(int);
final SetProcessDpiAwareness = DynamicLibrary.open('api-ms-win-shcore-scaling-l1-1-1.dll')
    .lookupFunction<SetProcessDpiAwarenessNative, SetProcessDpiAwarenessDart>('SetProcessDpiAwareness');
// value : PROCESS_DPI_AWARENESS -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetProcessDpiAwareness(
  value: Integer   // PROCESS_DPI_AWARENESS
): Integer; stdcall;
  external 'api-ms-win-shcore-scaling-l1-1-1.dll' name 'SetProcessDpiAwareness';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetProcessDpiAwareness"
  c_SetProcessDpiAwareness :: Int32 -> IO Int32
-- value : PROCESS_DPI_AWARENESS -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setprocessdpiawareness =
  foreign "SetProcessDpiAwareness"
    (int32_t @-> returning int32_t)
(* value : PROCESS_DPI_AWARENESS -> int32_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 ("SetProcessDpiAwareness" set-process-dpi-awareness :convention :stdcall) :int32
  (value :int32))   ; PROCESS_DPI_AWARENESS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetProcessDpiAwareness = Win32::API::More->new('api-ms-win-shcore-scaling-l1-1-1',
    'int SetProcessDpiAwareness(int value)');
# my $ret = $SetProcessDpiAwareness->Call($value);
# value : PROCESS_DPI_AWARENESS -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型