ホーム › UI.Controls › GetThemeBackgroundExtent

GetThemeBackgroundExtent

関数

指定コンテンツ矩形を含むテーマ背景全体の外接矩形を取得する。

DLLUXTHEME.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT GetThemeBackgroundExtent(
    HTHEME hTheme,
    HDC hdc,   // optional
    INT iPartId,
    INT iStateId,
    RECT* pContentRect,
    RECT* pExtentRect
);

パラメーター

名前	型	方向	説明
hTheme	HTHEME	in	ウィンドウに指定されたテーマデータへのハンドルです。HTHEME の作成には OpenThemeData を使用します。
hdc	HDC	inoptional	描画に使用する HDC です。このパラメーターには NULL を指定できます。
iPartId	INT	in	コンテンツを含むパーツを指定する int 型の値です。Parts and States を参照してください。
iStateId	INT	in	コンテンツを含むパーツの状態を指定する int 型の値です。Parts and States を参照してください。
pContentRect	RECT*	in	コンテンツの背景矩形を論理座標で格納した RECT 構造体へのポインターです。この矩形は GetThemeBackgroundContentRect から返されます。
pExtentRect	RECT*	out	背景矩形を論理座標で受け取る RECT 構造体へのポインターです。この矩形は pContentRect に基づいて算出されます。

戻り値の型: HRESULT

公式ドキュメント

コンテンツ領域を指定して、ビジュアルスタイルで定義された背景のサイズと位置を計算します。

戻り値

型: HRESULT

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

解説(Remarks)

テーマでは、各背景イメージ内にコンテンツ領域を定義できます。これは、テキストやアイコンなどのコンテンツを、背景の境界線を上書きせずに配置できる領域です。

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

各言語での呼び出し定義

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

HRESULT GetThemeBackgroundExtent(
    HTHEME hTheme,
    HDC hdc,   // optional
    INT iPartId,
    INT iStateId,
    RECT* pContentRect,
    RECT* pExtentRect
);

[DllImport("UXTHEME.dll", ExactSpelling = true)]
static extern int GetThemeBackgroundExtent(
    IntPtr hTheme,   // HTHEME
    IntPtr hdc,   // HDC optional
    int iPartId,   // INT
    int iStateId,   // INT
    IntPtr pContentRect,   // RECT*
    IntPtr pExtentRect   // RECT* out
);

<DllImport("UXTHEME.dll", ExactSpelling:=True)>
Public Shared Function GetThemeBackgroundExtent(
    hTheme As IntPtr,   ' HTHEME
    hdc As IntPtr,   ' HDC optional
    iPartId As Integer,   ' INT
    iStateId As Integer,   ' INT
    pContentRect As IntPtr,   ' RECT*
    pExtentRect As IntPtr   ' RECT* out
) As Integer
End Function

' hTheme : HTHEME
' hdc : HDC optional
' iPartId : INT
' iStateId : INT
' pContentRect : RECT*
' pExtentRect : RECT* out
Declare PtrSafe Function GetThemeBackgroundExtent Lib "uxtheme" ( _
    ByVal hTheme As LongPtr, _
    ByVal hdc As LongPtr, _
    ByVal iPartId As Long, _
    ByVal iStateId As Long, _
    ByVal pContentRect As LongPtr, _
    ByVal pExtentRect As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetThemeBackgroundExtent = ctypes.windll.uxtheme.GetThemeBackgroundExtent
GetThemeBackgroundExtent.restype = ctypes.c_int
GetThemeBackgroundExtent.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,  # pContentRect : RECT*
    ctypes.c_void_p,  # pExtentRect : RECT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('UXTHEME.dll')
GetThemeBackgroundExtent = Fiddle::Function.new(
  lib['GetThemeBackgroundExtent'],
  [
    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,  # pContentRect : RECT*
    Fiddle::TYPE_VOIDP,  # pExtentRect : RECT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "uxtheme")]
extern "system" {
    fn GetThemeBackgroundExtent(
        hTheme: isize,  // HTHEME
        hdc: *mut core::ffi::c_void,  // HDC optional
        iPartId: i32,  // INT
        iStateId: i32,  // INT
        pContentRect: *mut RECT,  // RECT*
        pExtentRect: *mut RECT  // RECT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("UXTHEME.dll")]
public static extern int GetThemeBackgroundExtent(IntPtr hTheme, IntPtr hdc, int iPartId, int iStateId, IntPtr pContentRect, IntPtr pExtentRect);
"@
$api = Add-Type -MemberDefinition $sig -Name 'UXTHEME_GetThemeBackgroundExtent' -Namespace Win32 -PassThru
# $api::GetThemeBackgroundExtent(hTheme, hdc, iPartId, iStateId, pContentRect, pExtentRect)

#uselib "UXTHEME.dll"
#func global GetThemeBackgroundExtent "GetThemeBackgroundExtent" sptr, sptr, sptr, sptr, sptr, sptr
; GetThemeBackgroundExtent hTheme, hdc, iPartId, iStateId, varptr(pContentRect), varptr(pExtentRect)   ; 戻り値は stat
; hTheme : HTHEME -> "sptr"
; hdc : HDC optional -> "sptr"
; iPartId : INT -> "sptr"
; iStateId : INT -> "sptr"
; pContentRect : RECT* -> "sptr"
; pExtentRect : RECT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "UXTHEME.dll"
#cfunc global GetThemeBackgroundExtent "GetThemeBackgroundExtent" sptr, sptr, int, int, var, var
; res = GetThemeBackgroundExtent(hTheme, hdc, iPartId, iStateId, pContentRect, pExtentRect)
; hTheme : HTHEME -> "sptr"
; hdc : HDC optional -> "sptr"
; iPartId : INT -> "int"
; iStateId : INT -> "int"
; pContentRect : RECT* -> "var"
; pExtentRect : RECT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "UXTHEME.dll"
#cfunc global GetThemeBackgroundExtent "GetThemeBackgroundExtent" sptr, sptr, int, int, sptr, sptr
; res = GetThemeBackgroundExtent(hTheme, hdc, iPartId, iStateId, varptr(pContentRect), varptr(pExtentRect))
; hTheme : HTHEME -> "sptr"
; hdc : HDC optional -> "sptr"
; iPartId : INT -> "int"
; iStateId : INT -> "int"
; pContentRect : RECT* -> "sptr"
; pExtentRect : RECT* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。