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

RealizePalette

関数
論理パレットをシステムパレットへ反映する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD RealizePalette(
    HDC hdc
);

パラメーター

名前方向説明
hdcHDCin論理パレットが選択されているデバイスコンテキストへのハンドル。

戻り値の型: DWORD

公式ドキュメント

RealizePalette 関数は、現在の論理パレットのパレットエントリをシステムパレットにマッピングします。

戻り値

関数が成功した場合、戻り値はシステムパレットにマッピングされた論理パレット内のエントリ数です。

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

解説(Remarks)

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

RealizePalette 関数は、指定されたデバイスコンテキストに関連付けられているデバイスのパレットを変更します。デバイスコンテキストがメモリ DC の場合、その DC に選択されているビットマップのカラーテーブルが変更されます。デバイスコンテキストがディスプレイ DC の場合、そのデバイスの物理パレットが変更されます。

論理パレットは、色を多用するアプリケーションとシステムとの間のバッファーとして機能し、これらのアプリケーションが他のウィンドウで表示される色を妨げることなく、必要な数だけ色を使用できるようにします。

アプリケーションのウィンドウがフォーカスを持っているときに RealizePalette 関数を呼び出すと、システムは要求された色をできるだけ多く実現しようとします。これは、非アクティブなウィンドウを持つアプリケーションについても同様です。

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

各言語での呼び出し定義

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

DWORD RealizePalette(
    HDC hdc
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern uint RealizePalette(
    IntPtr hdc   // HDC
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function RealizePalette(
    hdc As IntPtr   ' HDC
) As UInteger
End Function
' hdc : HDC
Declare PtrSafe Function RealizePalette 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

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

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procRealizePalette = gdi32.NewProc("RealizePalette")
)

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

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

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

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

let realizepalette =
  foreign "RealizePalette"
    ((ptr void) @-> returning uint32_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 ("RealizePalette" realize-palette :convention :stdcall) :uint32
  (hdc :pointer))   ; HDC
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RealizePalette = Win32::API::More->new('GDI32',
    'DWORD RealizePalette(HANDLE hdc)');
# my $ret = $RealizePalette->Call($hdc);
# hdc : HDC -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目