Win32 API 日本語リファレンス
ホームUI.Controls › GetThemeBackgroundRegion

GetThemeBackgroundRegion

関数
テーマ背景の領域(リージョン)を取得する。
DLLUXTHEME.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT GetThemeBackgroundRegion(
    HTHEME hTheme,
    HDC hdc,   // optional
    INT iPartId,
    INT iStateId,
    RECT* pRect,
    HRGN* pRegion
);

パラメーター

名前方向説明
hThemeHTHEMEinウィンドウの指定されたテーマデータへのハンドル。HTHEME を作成するには OpenThemeData を使用します。
hdcHDCinoptional描画先の HDC。この DC は dots per inch (DPI) スケーリングを使用します。このパラメーターには NULL を設定できます。
iPartIdINTinリージョンを含むパートを指定する int 型の値。Parts and States を参照してください。
iStateIdINTinパートの状態を指定する int 型の値。Parts and States を参照してください。
pRectRECT*inリージョンの計算に使用する指定の矩形を論理座標で格納した RECT 構造体へのポインター。
pRegionHRGN*out計算された region のハンドルへのポインター。

戻り値の型: HRESULT

公式ドキュメント

指定した矩形で境界付けられた、通常または部分的に透明な背景のリージョンを計算します。

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

この関数によって返されるリージョンハンドルは、不要になった時点で DeleteObject を使用して解放する必要があります。

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

各言語での呼び出し定義

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

HRESULT GetThemeBackgroundRegion(
    HTHEME hTheme,
    HDC hdc,   // optional
    INT iPartId,
    INT iStateId,
    RECT* pRect,
    HRGN* pRegion
);
[DllImport("UXTHEME.dll", ExactSpelling = true)]
static extern int GetThemeBackgroundRegion(
    IntPtr hTheme,   // HTHEME
    IntPtr hdc,   // HDC optional
    int iPartId,   // INT
    int iStateId,   // INT
    IntPtr pRect,   // RECT*
    IntPtr pRegion   // HRGN* out
);
<DllImport("UXTHEME.dll", ExactSpelling:=True)>
Public Shared Function GetThemeBackgroundRegion(
    hTheme As IntPtr,   ' HTHEME
    hdc As IntPtr,   ' HDC optional
    iPartId As Integer,   ' INT
    iStateId As Integer,   ' INT
    pRect As IntPtr,   ' RECT*
    pRegion As IntPtr   ' HRGN* out
) As Integer
End Function
' hTheme : HTHEME
' hdc : HDC optional
' iPartId : INT
' iStateId : INT
' pRect : RECT*
' pRegion : HRGN* out
Declare PtrSafe Function GetThemeBackgroundRegion Lib "uxtheme" ( _
    ByVal hTheme As LongPtr, _
    ByVal hdc As LongPtr, _
    ByVal iPartId As Long, _
    ByVal iStateId As Long, _
    ByVal pRect As LongPtr, _
    ByVal pRegion As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetThemeBackgroundRegion = ctypes.windll.uxtheme.GetThemeBackgroundRegion
GetThemeBackgroundRegion.restype = ctypes.c_int
GetThemeBackgroundRegion.argtypes = [
    ctypes.c_ssize_t,  # hTheme : HTHEME
    wintypes.HANDLE,  # hdc : HDC optional
    ctypes.c_int,  # iPartId : INT
    ctypes.c_int,  # iStateId : INT
    ctypes.c_void_p,  # pRect : RECT*
    ctypes.c_void_p,  # pRegion : HRGN* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('UXTHEME.dll')
GetThemeBackgroundRegion = Fiddle::Function.new(
  lib['GetThemeBackgroundRegion'],
  [
    Fiddle::TYPE_INTPTR_T,  # hTheme : HTHEME
    Fiddle::TYPE_VOIDP,  # hdc : HDC optional
    Fiddle::TYPE_INT,  # iPartId : INT
    Fiddle::TYPE_INT,  # iStateId : INT
    Fiddle::TYPE_VOIDP,  # pRect : RECT*
    Fiddle::TYPE_VOIDP,  # pRegion : HRGN* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "uxtheme")]
extern "system" {
    fn GetThemeBackgroundRegion(
        hTheme: isize,  // HTHEME
        hdc: *mut core::ffi::c_void,  // HDC optional
        iPartId: i32,  // INT
        iStateId: i32,  // INT
        pRect: *mut RECT,  // RECT*
        pRegion: *mut *mut core::ffi::c_void  // HRGN* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("UXTHEME.dll")]
public static extern int GetThemeBackgroundRegion(IntPtr hTheme, IntPtr hdc, int iPartId, int iStateId, IntPtr pRect, IntPtr pRegion);
"@
$api = Add-Type -MemberDefinition $sig -Name 'UXTHEME_GetThemeBackgroundRegion' -Namespace Win32 -PassThru
# $api::GetThemeBackgroundRegion(hTheme, hdc, iPartId, iStateId, pRect, pRegion)
#uselib "UXTHEME.dll"
#func global GetThemeBackgroundRegion "GetThemeBackgroundRegion" sptr, sptr, sptr, sptr, sptr, sptr
; GetThemeBackgroundRegion hTheme, hdc, iPartId, iStateId, varptr(pRect), pRegion   ; 戻り値は stat
; hTheme : HTHEME -> "sptr"
; hdc : HDC optional -> "sptr"
; iPartId : INT -> "sptr"
; iStateId : INT -> "sptr"
; pRect : RECT* -> "sptr"
; pRegion : HRGN* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "UXTHEME.dll"
#cfunc global GetThemeBackgroundRegion "GetThemeBackgroundRegion" sptr, sptr, int, int, var, sptr
; res = GetThemeBackgroundRegion(hTheme, hdc, iPartId, iStateId, pRect, pRegion)
; hTheme : HTHEME -> "sptr"
; hdc : HDC optional -> "sptr"
; iPartId : INT -> "int"
; iStateId : INT -> "int"
; pRect : RECT* -> "var"
; pRegion : HRGN* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT GetThemeBackgroundRegion(HTHEME hTheme, HDC hdc, INT iPartId, INT iStateId, RECT* pRect, HRGN* pRegion)
#uselib "UXTHEME.dll"
#cfunc global GetThemeBackgroundRegion "GetThemeBackgroundRegion" intptr, intptr, int, int, var, intptr
; res = GetThemeBackgroundRegion(hTheme, hdc, iPartId, iStateId, pRect, pRegion)
; hTheme : HTHEME -> "intptr"
; hdc : HDC optional -> "intptr"
; iPartId : INT -> "int"
; iStateId : INT -> "int"
; pRect : RECT* -> "var"
; pRegion : HRGN* out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	uxtheme = windows.NewLazySystemDLL("UXTHEME.dll")
	procGetThemeBackgroundRegion = uxtheme.NewProc("GetThemeBackgroundRegion")
)

// hTheme (HTHEME), hdc (HDC optional), iPartId (INT), iStateId (INT), pRect (RECT*), pRegion (HRGN* out)
r1, _, err := procGetThemeBackgroundRegion.Call(
	uintptr(hTheme),
	uintptr(hdc),
	uintptr(iPartId),
	uintptr(iStateId),
	uintptr(pRect),
	uintptr(pRegion),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function GetThemeBackgroundRegion(
  hTheme: NativeInt;   // HTHEME
  hdc: THandle;   // HDC optional
  iPartId: Integer;   // INT
  iStateId: Integer;   // INT
  pRect: Pointer;   // RECT*
  pRegion: Pointer   // HRGN* out
): Integer; stdcall;
  external 'UXTHEME.dll' name 'GetThemeBackgroundRegion';
result := DllCall("UXTHEME\GetThemeBackgroundRegion"
    , "Ptr", hTheme   ; HTHEME
    , "Ptr", hdc   ; HDC optional
    , "Int", iPartId   ; INT
    , "Int", iStateId   ; INT
    , "Ptr", pRect   ; RECT*
    , "Ptr", pRegion   ; HRGN* out
    , "Int")   ; return: HRESULT
●GetThemeBackgroundRegion(hTheme, hdc, iPartId, iStateId, pRect, pRegion) = DLL("UXTHEME.dll", "int GetThemeBackgroundRegion(int, void*, int, int, void*, void*)")
# 呼び出し: GetThemeBackgroundRegion(hTheme, hdc, iPartId, iStateId, pRect, pRegion)
# hTheme : HTHEME -> "int"
# hdc : HDC optional -> "void*"
# iPartId : INT -> "int"
# iStateId : INT -> "int"
# pRect : RECT* -> "void*"
# pRegion : HRGN* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef GetThemeBackgroundRegionNative = Int32 Function(IntPtr, Pointer<Void>, Int32, Int32, Pointer<Void>, Pointer<Void>);
typedef GetThemeBackgroundRegionDart = int Function(int, Pointer<Void>, int, int, Pointer<Void>, Pointer<Void>);
final GetThemeBackgroundRegion = DynamicLibrary.open('UXTHEME.dll')
    .lookupFunction<GetThemeBackgroundRegionNative, GetThemeBackgroundRegionDart>('GetThemeBackgroundRegion');
// hTheme : HTHEME -> IntPtr
// hdc : HDC optional -> Pointer<Void>
// iPartId : INT -> Int32
// iStateId : INT -> Int32
// pRect : RECT* -> Pointer<Void>
// pRegion : HRGN* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetThemeBackgroundRegion(
  hTheme: NativeInt;   // HTHEME
  hdc: THandle;   // HDC optional
  iPartId: Integer;   // INT
  iStateId: Integer;   // INT
  pRect: Pointer;   // RECT*
  pRegion: Pointer   // HRGN* out
): Integer; stdcall;
  external 'UXTHEME.dll' name 'GetThemeBackgroundRegion';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetThemeBackgroundRegion"
  c_GetThemeBackgroundRegion :: CIntPtr -> Ptr () -> Int32 -> Int32 -> Ptr () -> Ptr () -> IO Int32
-- hTheme : HTHEME -> CIntPtr
-- hdc : HDC optional -> Ptr ()
-- iPartId : INT -> Int32
-- iStateId : INT -> Int32
-- pRect : RECT* -> Ptr ()
-- pRegion : HRGN* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getthemebackgroundregion =
  foreign "GetThemeBackgroundRegion"
    (intptr_t @-> (ptr void) @-> int32_t @-> int32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hTheme : HTHEME -> intptr_t *)
(* hdc : HDC optional -> (ptr void) *)
(* iPartId : INT -> int32_t *)
(* iStateId : INT -> int32_t *)
(* pRect : RECT* -> (ptr void) *)
(* pRegion : HRGN* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library uxtheme (t "UXTHEME.dll"))
(cffi:use-foreign-library uxtheme)

(cffi:defcfun ("GetThemeBackgroundRegion" get-theme-background-region :convention :stdcall) :int32
  (h-theme :int64)   ; HTHEME
  (hdc :pointer)   ; HDC optional
  (i-part-id :int32)   ; INT
  (i-state-id :int32)   ; INT
  (p-rect :pointer)   ; RECT*
  (p-region :pointer))   ; HRGN* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetThemeBackgroundRegion = Win32::API::More->new('UXTHEME',
    'int GetThemeBackgroundRegion(LPARAM hTheme, HANDLE hdc, int iPartId, int iStateId, LPVOID pRect, HANDLE pRegion)');
# my $ret = $GetThemeBackgroundRegion->Call($hTheme, $hdc, $iPartId, $iStateId, $pRect, $pRegion);
# hTheme : HTHEME -> LPARAM
# hdc : HDC optional -> HANDLE
# iPartId : INT -> int
# iStateId : INT -> int
# pRect : RECT* -> LPVOID
# pRegion : HRGN* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型