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

SetBkColor

関数
デバイスコンテキストの現在の背景色を設定する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

COLORREF SetBkColor(
    HDC hdc,
    COLORREF color
);

パラメーター

名前方向説明
hdcHDCinデバイス コンテキストへのハンドルです。
colorCOLORREFin新しい背景色です。COLORREF 値を作成するには、RGB マクロを使用します。

戻り値の型: COLORREF

公式ドキュメント

SetBkColor 関数は、現在の背景色を指定した色の値に設定します。デバイスが指定した色の値を表現できない場合は、最も近い物理的な色に設定します。

戻り値

関数が成功した場合、戻り値は以前の背景色を COLORREF 値として返します。

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

解説(Remarks)

この関数は、CreatePen 関数で作成したペンを使って描画されたスタイル付きの線の間隙を塗りつぶします。ExtCreatePen 関数で作成したペンを使って描画されたスタイル付きの線の間隙は塗りつぶしません。また、SetBkColor 関数は、TextOut および ExtTextOut の背景色も設定します。

背景モードが OPAQUE の場合、背景色は、スタイル付きの線の間隙、ブラシ内のハッチング線の間隙、および文字セルの塗りつぶしに使用されます。背景色は、ビットマップをカラーからモノクロへ、またはその逆に変換する際にも使用されます。

例については、Using Menus の「Example of Owner-Drawn Menu Items」を参照してください。

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

各言語での呼び出し定義

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

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

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

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procSetBkColor = gdi32.NewProc("SetBkColor")
)

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

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

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

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

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

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

関連項目

公式の関連項目