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

SelectPalette

関数
デバイスコンテキストに論理パレットを選択する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HPALETTE SelectPalette(
    HDC hdc,
    HPALETTE hPal,
    BOOL bForceBkgd
);

パラメーター

名前方向説明
hdcHDCinデバイスコンテキストへのハンドル。
hPalHPALETTEin選択する論理パレットへのハンドル。
bForceBkgdBOOLin

論理パレットをバックグラウンドパレットとして強制するかどうかを指定します。この値が TRUE の場合、RealizePalette 関数は、論理パレットを物理パレット内に既に存在する色へ可能な限り最適な方法でマッピングします。これは、パレットを実現するウィンドウがアクティブフォーカスを持たないスレッドに属している場合でも、常に実行されます。

この値が FALSE の場合、アプリケーションがフォアグラウンドにあるとき、RealizePalette は論理パレットをデバイスパレットにコピーします。(hdc パラメーターがメモリデバイスコンテキストの場合、このパラメーターは無視されます。)

戻り値の型: HPALETTE

公式ドキュメント

SelectPalette 関数は、指定された論理パレットをデバイスコンテキストに選択します。

戻り値

関数が成功した場合、戻り値はデバイスコンテキストの以前の論理パレットへのハンドルです。

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

解説(Remarks)

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

アプリケーションは、デバイスコンテキストが互換性を持つ場合に限り、論理パレットを複数のデバイスコンテキストに選択できます。そうでない場合、SelectPalette は失敗します。あるデバイスコンテキストと互換性のあるデバイスコンテキストを作成するには、最初のデバイスコンテキストをパラメーターとして CreateCompatibleDC を呼び出します。論理パレットが複数のデバイスコンテキストに選択されている場合、論理パレットへの変更は、それが選択されているすべてのデバイスコンテキストに影響します。

トップレベルウィンドウの子ウィンドウがそれぞれ独自のパレットを実現する場合、アプリケーションは bForceBackground パラメーターを TRUE に設定して SelectPalette 関数を呼び出すことがあります。ただし、パレットを実現する必要がある子ウィンドウのみが bForceBackgroundTRUE に設定する必要があり、他の子ウィンドウはこの値を FALSE に設定する必要があります。

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

各言語での呼び出し定義

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

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

SelectPalette = ctypes.windll.gdi32.SelectPalette
SelectPalette.restype = ctypes.c_void_p
SelectPalette.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.HANDLE,  # hPal : HPALETTE
    wintypes.BOOL,  # bForceBkgd : BOOL
]
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procSelectPalette = gdi32.NewProc("SelectPalette")
)

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

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

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

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

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

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

関連項目

公式の関連項目