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

GetBkColor

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

シグネチャ

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

COLORREF GetBkColor(
    HDC hdc
);

パラメーター

名前方向説明
hdcHDCin背景色を取得するデバイスコンテキストへのハンドル。

戻り値の型: COLORREF

公式ドキュメント

GetBkColor 関数は、指定したデバイスコンテキストの現在の背景色を返します。

戻り値

関数が成功した場合、戻り値は現在の背景色を表す COLORREF 値です。

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

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

各言語での呼び出し定義

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

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

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

lib = Fiddle.dlopen('GDI32.dll')
GetBkColor = Fiddle::Function.new(
  lib['GetBkColor'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
  ],
  -Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn GetBkColor(
        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 GetBkColor(IntPtr hdc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetBkColor' -Namespace Win32 -PassThru
# $api::GetBkColor(hdc)
#uselib "GDI32.dll"
#func global GetBkColor "GetBkColor" sptr
; GetBkColor hdc   ; 戻り値は stat
; hdc : HDC -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "GDI32.dll"
#cfunc global GetBkColor "GetBkColor" sptr
; res = GetBkColor(hdc)
; hdc : HDC -> "sptr"
; COLORREF GetBkColor(HDC hdc)
#uselib "GDI32.dll"
#cfunc global GetBkColor "GetBkColor" intptr
; res = GetBkColor(hdc)
; hdc : HDC -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procGetBkColor = gdi32.NewProc("GetBkColor")
)

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

extern "gdi32" fn GetBkColor(
    hdc: ?*anyopaque // HDC
) callconv(std.os.windows.WINAPI) u32;
proc GetBkColor(
    hdc: pointer  # HDC
): uint32 {.importc: "GetBkColor", stdcall, dynlib: "GDI32.dll".}
pragma(lib, "gdi32");
extern(Windows)
uint GetBkColor(
    void* hdc   // HDC
);
ccall((:GetBkColor, "GDI32.dll"), stdcall, UInt32,
      (Ptr{Cvoid},),
      hdc)
# hdc : HDC -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetBkColor(
    void* hdc);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.GetBkColor(hdc)
-- hdc : HDC
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const GetBkColor = lib.func('__stdcall', 'GetBkColor', 'uint32_t', ['void *']);
// GetBkColor(hdc)
// hdc : HDC -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  GetBkColor: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.GetBkColor(hdc)
// hdc : HDC -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetBkColor(
    void* hdc);
C, "GDI32.dll");
// $ffi->GetBkColor(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 GetBkColor(
        Pointer hdc   // HDC
    );
}
@[Link("gdi32")]
lib LibGDI32
  fun GetBkColor = GetBkColor(
    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 GetBkColorNative = Uint32 Function(Pointer<Void>);
typedef GetBkColorDart = int Function(Pointer<Void>);
final GetBkColor = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<GetBkColorNative, GetBkColorDart>('GetBkColor');
// hdc : HDC -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetBkColor(
  hdc: THandle   // HDC
): DWORD; stdcall;
  external 'GDI32.dll' name 'GetBkColor';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

公式の関連項目