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

UpdateColors

関数
システムパレット変更に合わせてクライアント領域の色を更新する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL UpdateColors(
    HDC hdc
);

パラメーター

名前方向説明
hdcHDCinデバイスコンテキストへのハンドル。

戻り値の型: BOOL

公式ドキュメント

UpdateColors 関数は、指定されたデバイスコンテキストのクライアント領域を更新します。クライアント領域内の現在の色を、現在実現されている論理パレットに再マッピングします。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。

解説(Remarks)

アプリケーションは、GetDeviceCaps 関数を呼び出して RASTERCAPS 定数を指定することにより、デバイスがパレット操作をサポートしているかどうかを判別できます。

実現された論理パレットを持つ非アクティブなウィンドウは、システムパレットが変化したときに、クライアント領域を再描画する代わりに UpdateColors を呼び出すことができます。

UpdateColors 関数は通常、領域を再描画するよりも高速にクライアント領域を更新します。ただし、UpdateColors はシステムパレットが変化する前の各ピクセルの色に基づいて色変換を行うため、この関数を呼び出すたびに色の精度が多少失われます。

この関数は、WM_PALETTECHANGED メッセージを受信した直後に呼び出す必要があります。

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

各言語での呼び出し定義

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

BOOL UpdateColors(
    HDC hdc
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool UpdateColors(
    IntPtr hdc   // HDC
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function UpdateColors(
    hdc As IntPtr   ' HDC
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hdc : HDC
Declare PtrSafe Function UpdateColors Lib "gdi32" ( _
    ByVal hdc As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

UpdateColors = ctypes.windll.gdi32.UpdateColors
UpdateColors.restype = wintypes.BOOL
UpdateColors.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
UpdateColors = Fiddle::Function.new(
  lib['UpdateColors'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn UpdateColors(
        hdc: *mut core::ffi::c_void  // HDC
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool UpdateColors(IntPtr hdc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_UpdateColors' -Namespace Win32 -PassThru
# $api::UpdateColors(hdc)
#uselib "GDI32.dll"
#func global UpdateColors "UpdateColors" sptr
; UpdateColors hdc   ; 戻り値は stat
; hdc : HDC -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "GDI32.dll"
#cfunc global UpdateColors "UpdateColors" sptr
; res = UpdateColors(hdc)
; hdc : HDC -> "sptr"
; BOOL UpdateColors(HDC hdc)
#uselib "GDI32.dll"
#cfunc global UpdateColors "UpdateColors" intptr
; res = UpdateColors(hdc)
; hdc : HDC -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procUpdateColors = gdi32.NewProc("UpdateColors")
)

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

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

typedef UpdateColorsNative = Int32 Function(Pointer<Void>);
typedef UpdateColorsDart = int Function(Pointer<Void>);
final UpdateColors = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<UpdateColorsNative, UpdateColorsDart>('UpdateColors');
// hdc : HDC -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UpdateColors(
  hdc: THandle   // HDC
): BOOL; stdcall;
  external 'GDI32.dll' name 'UpdateColors';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UpdateColors"
  c_UpdateColors :: Ptr () -> IO CInt
-- hdc : HDC -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let updatecolors =
  foreign "UpdateColors"
    ((ptr void) @-> returning int32_t)
(* hdc : HDC -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("UpdateColors" update-colors :convention :stdcall) :int32
  (hdc :pointer))   ; HDC
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UpdateColors = Win32::API::More->new('GDI32',
    'BOOL UpdateColors(HANDLE hdc)');
# my $ret = $UpdateColors->Call($hdc);
# hdc : HDC -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目