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

SetSystemPaletteUse

関数
システムパレットの使用方法を設定する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD SetSystemPaletteUse(
    HDC hdc,
    SYSTEM_PALETTE_USE use
);

パラメーター

名前方向説明
hdcHDCinデバイスコンテキストへのハンドル。このデバイスコンテキストは、カラーパレットをサポートするデバイスを参照している必要があります。
useSYSTEM_PALETTE_USEin

システムパレットの新しい使用方法。このパラメーターには、次のいずれかの値を指定できます。

意味
SYSPAL_NOSTATIC
システムパレットには 2 色の静的カラー(黒と白)が含まれます。
SYSPAL_NOSTATIC256
システムパレットには静的カラーが含まれません。
SYSPAL_STATIC
システムパレットには、アプリケーションが論理パレットを実現しても変化しない静的カラーが含まれます。

戻り値の型: DWORD

公式ドキュメント

SetSystemPaletteUse 関数は、システムパレットが 2 色または 20 色の静的カラーを含むかどうかをアプリケーションが指定できるようにします。

戻り値

関数が成功した場合、戻り値は以前のシステムパレットです。SYSPAL_NOSTATICSYSPAL_NOSTATIC256、または SYSPAL_STATIC のいずれかになります。

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

解説(Remarks)

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

アプリケーションウィンドウがフォアグラウンドに移動し、SYSPAL_NOSTATIC 値が設定されている場合、アプリケーションは GetSysColor 関数を呼び出して、現在のシステムカラー設定を保存する必要があります。また、SetSysColors を呼び出して、黒と白のみを使用した妥当な値を設定する必要もあります。アプリケーションがバックグラウンドに戻る、または終了する際には、以前のシステムカラーを復元する必要があります。

関数が SYSPAL_ERROR を返す場合、指定されたデバイスコンテキストが無効であるか、カラーパレットをサポートしていません。

アプリケーションは、ウィンドウが最大化され、入力フォーカスを持っている場合にのみ、この関数を呼び出す必要があります。

アプリケーションが uUsageSYSPAL_NOSTATIC に設定して SetSystemPaletteUse を呼び出した場合、システムは引き続きシステムパレット内に純白と純黒用の 2 つのエントリーをそれぞれ確保します。

uUsageSYSPAL_NOSTATIC に設定してこの関数を呼び出した後、アプリケーションは次の手順を実行する必要があります。

  1. 論理パレットを実現します。
  2. GetSysColor 関数を呼び出して、現在のシステムカラー設定を保存します。
  3. SetSysColors 関数を呼び出して、黒と白を使用した妥当な値にシステムカラーを設定します。たとえば、隣接または重なり合う項目(ウィンドウフレームと境界線など)は、それぞれ黒と白に設定する必要があります。
  4. WM_SYSCOLORCHANGE メッセージを他のトップレベルウィンドウに送信し、新しいシステムカラーで再描画できるようにします。
アプリケーションのウィンドウがフォーカスを失う、または閉じられる際には、アプリケーションは次の手順を実行する必要があります。
  1. uUsage パラメーターを SYSPAL_STATIC に設定して SetSystemPaletteUse を呼び出します。
  2. 論理パレットを実現します。
  3. システムカラーを以前の値に復元します。
  4. WM_SYSCOLORCHANGE メッセージを送信します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

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

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procSetSystemPaletteUse = gdi32.NewProc("SetSystemPaletteUse")
)

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

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

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

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

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

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

関連項目

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