Win32 API 日本語リファレンス
ホームGraphics.Gdi › ChangeDisplaySettingsW

ChangeDisplaySettingsW

関数
既定ディスプレイの表示設定を変更する(Unicode版)。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

DISP_CHANGE ChangeDisplaySettingsW(
    DEVMODEW* lpDevMode,   // optional
    CDS_TYPE dwFlags
);

パラメーター

名前方向説明
lpDevModeDEVMODEW*inoptional

新しいグラフィック モードを記述する DEVMODE 構造体へのポインターです。lpDevModeNULL の場合、ディスプレイ設定には現在レジストリにあるすべての値が使用されます。lpDevMode パラメーターに NULL を、dwFlags パラメーターに 0 を渡すことは、動的なモード変更の後に既定のモードに戻す最も簡単な方法です。

DEVMODEdmSize メンバーには、DEVMODE 構造体のサイズ(バイト単位)を初期化する必要があります。DEVMODEdmDriverExtra メンバーには、DEVMODE 構造体に続くプライベート ドライバー データのバイト数を初期化する必要があります。さらに、DEVMODE 構造体の次のメンバーのいずれか、またはすべてを使用できます。

メンバー 意味
dmBitsPerPel ピクセルあたりのビット数
dmPelsWidth ピクセル幅
dmPelsHeight ピクセル高さ
dmDisplayFlags モード フラグ
dmDisplayFrequency モード周波数
dmPosition マルチモニター構成におけるデバイスの位置。

前述の DEVMODE メンバーのうち 1 つ以上を使用することに加えて、ディスプレイ設定を変更するには、dmFields メンバーに次の値のうち 1 つ以上を設定する必要もあります。

意味
DM_BITSPERPEL dmBitsPerPel の値を使用します。
DM_PELSWIDTH dmPelsWidth の値を使用します。
DM_PELSHEIGHT dmPelsHeight の値を使用します。
DM_DISPLAYFLAGS dmDisplayFlags の値を使用します。
DM_DISPLAYFREQUENCY dmDisplayFrequency の値を使用します。
DM_POSITION dmPosition の値を使用します。
dwFlagsCDS_TYPEin

グラフィック モードをどのように変更するかを示します。このパラメーターには、次の値のいずれかを指定できます。

意味
0
現在の画面のグラフィック モードが動的に変更されます。
CDS_FULLSCREEN
モードは一時的なものです。

別のデスクトップに切り替えたり、そこから戻ったりしても、このモードはリセットされません。

CDS_GLOBAL
設定はグローバル設定領域に保存され、マシン上のすべてのユーザーに影響します。そうでない場合は、そのユーザーの設定のみが変更されます。このフラグは、CDS_UPDATEREGISTRY フラグとともに指定された場合にのみ有効です。
CDS_NORESET
設定はレジストリに保存されますが、有効にはなりません。このフラグは、CDS_UPDATEREGISTRY フラグとともに指定された場合にのみ有効です。
CDS_RESET
要求された設定が現在の設定と同じであっても、設定を変更します。
CDS_SET_PRIMARY
このデバイスがプライマリ デバイスになります。
CDS_TEST
システムは、要求されたグラフィック モードを設定できるかどうかをテストします。
CDS_UPDATEREGISTRY
現在の画面のグラフィック モードが動的に変更され、そのグラフィック モードがレジストリで更新されます。モード情報は USER プロファイルに格納されます。

CDS_TEST を指定すると、システムを実際にそのグラフィック モードに変更させることなく、どのグラフィック モードが実際に有効であるかをアプリケーションが判別できます。

CDS_UPDATEREGISTRY が指定され、グラフィック モードを動的に変更できる場合、情報はレジストリに格納され、DISP_CHANGE_SUCCESSFUL が返されます。グラフィック モードを動的に変更できない場合、情報はレジストリに格納され、DISP_CHANGE_RESTART が返されます。

CDS_UPDATEREGISTRY が指定され、情報をレジストリに格納できなかった場合、グラフィック モードは変更されず、DISP_CHANGE_NOTUPDATED が返されます。

戻り値の型: DISP_CHANGE

公式ドキュメント

ChangeDisplaySettings 関数は、既定のディスプレイ デバイスの設定を指定されたグラフィック モードに変更します。(Unicode)

戻り値

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

リターン コード 説明
DISP_CHANGE_SUCCESSFUL
設定の変更が成功しました。
DISP_CHANGE_BADDUALVIEW
システムが DualView 対応であるため、設定の変更に失敗しました。
DISP_CHANGE_BADFLAGS
無効なフラグのセットが渡されました。
DISP_CHANGE_BADMODE
そのグラフィック モードはサポートされていません。
DISP_CHANGE_BADPARAM
無効なパラメーターが渡されました。これには、無効なフラグまたはフラグの組み合わせが含まれる場合があります。
DISP_CHANGE_FAILED
ディスプレイ ドライバーが、指定されたグラフィック モードの設定に失敗しました。
DISP_CHANGE_NOTUPDATED
設定をレジストリに書き込めませんでした。
DISP_CHANGE_RESTART
グラフィック モードを有効にするには、コンピューターを再起動する必要があります。

解説(Remarks)

ChangeDisplaySettings に渡される DEVMODE 構造体が有効で、ディスプレイ ドライバーがサポートする値のみを含むようにするには、EnumDisplaySettings 関数が返す DEVMODE を使用してください。

ディスプレイ モードが動的に変更されると、WM_DISPLAYCHANGE メッセージが、次のメッセージ パラメーターとともに実行中のすべてのアプリケーションに送信されます。

パラメーター 意味
wParam 新しいピクセルあたりのビット数
LOWORD(lParam) 新しいピクセル幅
HIWORD(lParam) 新しいピクセル高さ

DPI 仮想化

この API は DPI 仮想化に参加しません。指定される入力は常に物理ピクセル単位であり、呼び出し元のコンテキストとは関係ありません。
メモ

winuser.h ヘッダーは、ChangeDisplaySettings を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディングに依存しないエイリアスの使用を、エンコーディングに依存しないわけではないコードと混在させると、コンパイル エラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

DISP_CHANGE ChangeDisplaySettingsW(
    DEVMODEW* lpDevMode,   // optional
    CDS_TYPE dwFlags
);
[DllImport("USER32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int ChangeDisplaySettingsW(
    IntPtr lpDevMode,   // DEVMODEW* optional
    uint dwFlags   // CDS_TYPE
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ChangeDisplaySettingsW(
    lpDevMode As IntPtr,   ' DEVMODEW* optional
    dwFlags As UInteger   ' CDS_TYPE
) As Integer
End Function
' lpDevMode : DEVMODEW* optional
' dwFlags : CDS_TYPE
Declare PtrSafe Function ChangeDisplaySettingsW Lib "user32" ( _
    ByVal lpDevMode As LongPtr, _
    ByVal dwFlags As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ChangeDisplaySettingsW = ctypes.windll.user32.ChangeDisplaySettingsW
ChangeDisplaySettingsW.restype = ctypes.c_int
ChangeDisplaySettingsW.argtypes = [
    ctypes.c_void_p,  # lpDevMode : DEVMODEW* optional
    wintypes.DWORD,  # dwFlags : CDS_TYPE
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
ChangeDisplaySettingsW = Fiddle::Function.new(
  lib['ChangeDisplaySettingsW'],
  [
    Fiddle::TYPE_VOIDP,  # lpDevMode : DEVMODEW* optional
    -Fiddle::TYPE_INT,  # dwFlags : CDS_TYPE
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn ChangeDisplaySettingsW(
        lpDevMode: *mut DEVMODEW,  // DEVMODEW* optional
        dwFlags: u32  // CDS_TYPE
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode)]
public static extern int ChangeDisplaySettingsW(IntPtr lpDevMode, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_ChangeDisplaySettingsW' -Namespace Win32 -PassThru
# $api::ChangeDisplaySettingsW(lpDevMode, dwFlags)
#uselib "USER32.dll"
#func global ChangeDisplaySettingsW "ChangeDisplaySettingsW" wptr, wptr
; ChangeDisplaySettingsW varptr(lpDevMode), dwFlags   ; 戻り値は stat
; lpDevMode : DEVMODEW* optional -> "wptr"
; dwFlags : CDS_TYPE -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global ChangeDisplaySettingsW "ChangeDisplaySettingsW" var, int
; res = ChangeDisplaySettingsW(lpDevMode, dwFlags)
; lpDevMode : DEVMODEW* optional -> "var"
; dwFlags : CDS_TYPE -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DISP_CHANGE ChangeDisplaySettingsW(DEVMODEW* lpDevMode, CDS_TYPE dwFlags)
#uselib "USER32.dll"
#cfunc global ChangeDisplaySettingsW "ChangeDisplaySettingsW" var, int
; res = ChangeDisplaySettingsW(lpDevMode, dwFlags)
; lpDevMode : DEVMODEW* optional -> "var"
; dwFlags : CDS_TYPE -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procChangeDisplaySettingsW = user32.NewProc("ChangeDisplaySettingsW")
)

// lpDevMode (DEVMODEW* optional), dwFlags (CDS_TYPE)
r1, _, err := procChangeDisplaySettingsW.Call(
	uintptr(lpDevMode),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DISP_CHANGE
function ChangeDisplaySettingsW(
  lpDevMode: Pointer;   // DEVMODEW* optional
  dwFlags: DWORD   // CDS_TYPE
): Integer; stdcall;
  external 'USER32.dll' name 'ChangeDisplaySettingsW';
result := DllCall("USER32\ChangeDisplaySettingsW"
    , "Ptr", lpDevMode   ; DEVMODEW* optional
    , "UInt", dwFlags   ; CDS_TYPE
    , "Int")   ; return: DISP_CHANGE
●ChangeDisplaySettingsW(lpDevMode, dwFlags) = DLL("USER32.dll", "int ChangeDisplaySettingsW(void*, dword)")
# 呼び出し: ChangeDisplaySettingsW(lpDevMode, dwFlags)
# lpDevMode : DEVMODEW* optional -> "void*"
# dwFlags : CDS_TYPE -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn ChangeDisplaySettingsW(
    lpDevMode: [*c]DEVMODEW, // DEVMODEW* optional
    dwFlags: u32 // CDS_TYPE
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc ChangeDisplaySettingsW(
    lpDevMode: ptr DEVMODEW,  # DEVMODEW* optional
    dwFlags: uint32  # CDS_TYPE
): int32 {.importc: "ChangeDisplaySettingsW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
int ChangeDisplaySettingsW(
    DEVMODEW* lpDevMode,   // DEVMODEW* optional
    uint dwFlags   // CDS_TYPE
);
ccall((:ChangeDisplaySettingsW, "USER32.dll"), stdcall, Int32,
      (Ptr{DEVMODEW}, UInt32),
      lpDevMode, dwFlags)
# lpDevMode : DEVMODEW* optional -> Ptr{DEVMODEW}
# dwFlags : CDS_TYPE -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t ChangeDisplaySettingsW(
    void* lpDevMode,
    uint32_t dwFlags);
]]
local user32 = ffi.load("user32")
-- user32.ChangeDisplaySettingsW(lpDevMode, dwFlags)
-- lpDevMode : DEVMODEW* optional
-- dwFlags : CDS_TYPE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const ChangeDisplaySettingsW = lib.func('__stdcall', 'ChangeDisplaySettingsW', 'int32_t', ['void *', 'uint32_t']);
// ChangeDisplaySettingsW(lpDevMode, dwFlags)
// lpDevMode : DEVMODEW* optional -> 'void *'
// dwFlags : CDS_TYPE -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  ChangeDisplaySettingsW: { parameters: ["pointer", "u32"], result: "i32" },
});
// lib.symbols.ChangeDisplaySettingsW(lpDevMode, dwFlags)
// lpDevMode : DEVMODEW* optional -> "pointer"
// dwFlags : CDS_TYPE -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ChangeDisplaySettingsW(
    void* lpDevMode,
    uint32_t dwFlags);
C, "USER32.dll");
// $ffi->ChangeDisplaySettingsW(lpDevMode, dwFlags);
// lpDevMode : DEVMODEW* optional
// dwFlags : CDS_TYPE
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    int ChangeDisplaySettingsW(
        Pointer lpDevMode,   // DEVMODEW* optional
        int dwFlags   // CDS_TYPE
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun ChangeDisplaySettingsW = ChangeDisplaySettingsW(
    lpDevMode : DEVMODEW*,   # DEVMODEW* optional
    dwFlags : UInt32   # CDS_TYPE
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ChangeDisplaySettingsWNative = Int32 Function(Pointer<Void>, Uint32);
typedef ChangeDisplaySettingsWDart = int Function(Pointer<Void>, int);
final ChangeDisplaySettingsW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<ChangeDisplaySettingsWNative, ChangeDisplaySettingsWDart>('ChangeDisplaySettingsW');
// lpDevMode : DEVMODEW* optional -> Pointer<Void>
// dwFlags : CDS_TYPE -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ChangeDisplaySettingsW(
  lpDevMode: Pointer;   // DEVMODEW* optional
  dwFlags: DWORD   // CDS_TYPE
): Integer; stdcall;
  external 'USER32.dll' name 'ChangeDisplaySettingsW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ChangeDisplaySettingsW"
  c_ChangeDisplaySettingsW :: Ptr () -> Word32 -> IO Int32
-- lpDevMode : DEVMODEW* optional -> Ptr ()
-- dwFlags : CDS_TYPE -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let changedisplaysettingsw =
  foreign "ChangeDisplaySettingsW"
    ((ptr void) @-> uint32_t @-> returning int32_t)
(* lpDevMode : DEVMODEW* optional -> (ptr void) *)
(* dwFlags : CDS_TYPE -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("ChangeDisplaySettingsW" change-display-settings-w :convention :stdcall) :int32
  (lp-dev-mode :pointer)   ; DEVMODEW* optional
  (dw-flags :uint32))   ; CDS_TYPE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ChangeDisplaySettingsW = Win32::API::More->new('USER32',
    'int ChangeDisplaySettingsW(LPVOID lpDevMode, DWORD dwFlags)');
# my $ret = $ChangeDisplaySettingsW->Call($lpDevMode, $dwFlags);
# lpDevMode : DEVMODEW* optional -> LPVOID
# dwFlags : CDS_TYPE -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
公式の関連項目
使用する型