Win32 API 日本語リファレンス
ホームSystem.Console › SetConsolePalette

SetConsolePalette

関数
コンソール画面に使用するカラーパレットを設定する内部関数。
DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

BOOL SetConsolePalette(
    HANDLE hConsoleOutput,
    HPALETTE hPalette,
    DWORD dwUsage
);

パラメーター

名前方向説明
hConsoleOutputHANDLEinコンソール画面バッファのハンドル。書き込みアクセス権を持つ出力ハンドルを指定する。
hPaletteHPALETTEinコンソールに設定する論理パレットのハンドル。表示色の対応付けに使用する。
dwUsageDWORDinパレットエントリの使用方法を示すフラグ。SYSPAL_NOSTATIC等の指定で色割当の挙動を制御する。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetConsolePalette(
    HANDLE hConsoleOutput,
    HPALETTE hPalette,
    DWORD dwUsage
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool SetConsolePalette(
    IntPtr hConsoleOutput,   // HANDLE
    IntPtr hPalette,   // HPALETTE
    uint dwUsage   // DWORD
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function SetConsolePalette(
    hConsoleOutput As IntPtr,   ' HANDLE
    hPalette As IntPtr,   ' HPALETTE
    dwUsage As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hConsoleOutput : HANDLE
' hPalette : HPALETTE
' dwUsage : DWORD
Declare PtrSafe Function SetConsolePalette Lib "kernel32" ( _
    ByVal hConsoleOutput As LongPtr, _
    ByVal hPalette As LongPtr, _
    ByVal dwUsage As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetConsolePalette = ctypes.windll.kernel32.SetConsolePalette
SetConsolePalette.restype = wintypes.BOOL
SetConsolePalette.argtypes = [
    wintypes.HANDLE,  # hConsoleOutput : HANDLE
    wintypes.HANDLE,  # hPalette : HPALETTE
    wintypes.DWORD,  # dwUsage : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetConsolePalette = kernel32.NewProc("SetConsolePalette")
)

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

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

typedef SetConsolePaletteNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32);
typedef SetConsolePaletteDart = int Function(Pointer<Void>, Pointer<Void>, int);
final SetConsolePalette = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetConsolePaletteNative, SetConsolePaletteDart>('SetConsolePalette');
// hConsoleOutput : HANDLE -> Pointer<Void>
// hPalette : HPALETTE -> Pointer<Void>
// dwUsage : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetConsolePalette(
  hConsoleOutput: THandle;   // HANDLE
  hPalette: THandle;   // HPALETTE
  dwUsage: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetConsolePalette';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetConsolePalette"
  c_SetConsolePalette :: Ptr () -> Ptr () -> Word32 -> IO CInt
-- hConsoleOutput : HANDLE -> Ptr ()
-- hPalette : HPALETTE -> Ptr ()
-- dwUsage : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setconsolepalette =
  foreign "SetConsolePalette"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hConsoleOutput : HANDLE -> (ptr void) *)
(* hPalette : HPALETTE -> (ptr void) *)
(* dwUsage : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetConsolePalette" set-console-palette :convention :stdcall) :int32
  (h-console-output :pointer)   ; HANDLE
  (h-palette :pointer)   ; HPALETTE
  (dw-usage :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetConsolePalette = Win32::API::More->new('KERNEL32',
    'BOOL SetConsolePalette(HANDLE hConsoleOutput, HANDLE hPalette, DWORD dwUsage)');
# my $ret = $SetConsolePalette->Call($hConsoleOutput, $hPalette, $dwUsage);
# hConsoleOutput : HANDLE -> HANDLE
# hPalette : HPALETTE -> HANDLE
# dwUsage : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。