GetThemeTextExtent

関数

テーマ書式で描画した際のテキストの外接矩形を取得する。

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

シグネチャ

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

HRESULT GetThemeTextExtent(
    HTHEME hTheme,
    HDC hdc,
    INT iPartId,
    INT iStateId,
    LPCWSTR pszText,
    INT cchCharCount,
    DRAW_TEXT_FORMAT dwTextFlags,
    RECT* pBoundingRect,   // optional
    RECT* pExtentRect
);

パラメーター

名前	型	方向	説明
hTheme	HTHEME	in	ウィンドウに指定されたテーマデータへのハンドル。HTHEME を作成するには OpenThemeData を使用します。
hdc	HDC	in	フォントを選択する対象の HDC。
iPartId	INT	in	テキストを描画するパートを指定する int 型の値。Parts and States を参照してください。
iStateId	INT	in	パートの状態を指定する int 型の値。Parts and States を参照してください。
pszText	LPCWSTR	in	描画するテキストを格納した文字列へのポインター。
cchCharCount	INT	in	描画する文字数を格納する int 型の値。このパラメーターを -1 に設定すると、文字列内のすべての文字が描画されます。
dwTextFlags	DRAW_TEXT_FORMAT	in	文字列の書式設定を指定する 1 つ以上の値を格納する DWORD。指定可能なパラメーター値については Format Values を参照してください。
pBoundingRect	RECT*	inoptional	テキストのレイアウトを制御するために使用する矩形を格納した RECT 構造体へのポインター。このパラメーターは NULL に設定できます。
pExtentRect	RECT*	out	描画されたテキストを収めるために必要な矩形を論理座標で格納する RECT 構造体へのポインター。

戻り値の型: HRESULT

公式ドキュメント

指定したテキストをビジュアルスタイルのフォントで描画した場合のサイズと位置を計算します。

戻り値

型: HRESULT

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

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

各言語での呼び出し定義

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

HRESULT GetThemeTextExtent(
    HTHEME hTheme,
    HDC hdc,
    INT iPartId,
    INT iStateId,
    LPCWSTR pszText,
    INT cchCharCount,
    DRAW_TEXT_FORMAT dwTextFlags,
    RECT* pBoundingRect,   // optional
    RECT* pExtentRect
);

[DllImport("UXTHEME.dll", ExactSpelling = true)]
static extern int GetThemeTextExtent(
    IntPtr hTheme,   // HTHEME
    IntPtr hdc,   // HDC
    int iPartId,   // INT
    int iStateId,   // INT
    [MarshalAs(UnmanagedType.LPWStr)] string pszText,   // LPCWSTR
    int cchCharCount,   // INT
    uint dwTextFlags,   // DRAW_TEXT_FORMAT
    IntPtr pBoundingRect,   // RECT* optional
    IntPtr pExtentRect   // RECT* out
);

<DllImport("UXTHEME.dll", ExactSpelling:=True)>
Public Shared Function GetThemeTextExtent(
    hTheme As IntPtr,   ' HTHEME
    hdc As IntPtr,   ' HDC
    iPartId As Integer,   ' INT
    iStateId As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPWStr)> pszText As String,   ' LPCWSTR
    cchCharCount As Integer,   ' INT
    dwTextFlags As UInteger,   ' DRAW_TEXT_FORMAT
    pBoundingRect As IntPtr,   ' RECT* optional
    pExtentRect As IntPtr   ' RECT* out
) As Integer
End Function

' hTheme : HTHEME
' hdc : HDC
' iPartId : INT
' iStateId : INT
' pszText : LPCWSTR
' cchCharCount : INT
' dwTextFlags : DRAW_TEXT_FORMAT
' pBoundingRect : RECT* optional
' pExtentRect : RECT* out
Declare PtrSafe Function GetThemeTextExtent Lib "uxtheme" ( _
    ByVal hTheme As LongPtr, _
    ByVal hdc As LongPtr, _
    ByVal iPartId As Long, _
    ByVal iStateId As Long, _
    ByVal pszText As LongPtr, _
    ByVal cchCharCount As Long, _
    ByVal dwTextFlags As Long, _
    ByVal pBoundingRect 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

GetThemeTextExtent = ctypes.windll.uxtheme.GetThemeTextExtent
GetThemeTextExtent.restype = ctypes.c_int
GetThemeTextExtent.argtypes = [
    ctypes.c_ssize_t,  # hTheme : HTHEME
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_int,  # iPartId : INT
    ctypes.c_int,  # iStateId : INT
    wintypes.LPCWSTR,  # pszText : LPCWSTR
    ctypes.c_int,  # cchCharCount : INT
    wintypes.DWORD,  # dwTextFlags : DRAW_TEXT_FORMAT
    ctypes.c_void_p,  # pBoundingRect : RECT* optional
    ctypes.c_void_p,  # pExtentRect : RECT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('UXTHEME.dll')
GetThemeTextExtent = Fiddle::Function.new(
  lib['GetThemeTextExtent'],
  [
    Fiddle::TYPE_INTPTR_T,  # hTheme : HTHEME
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_INT,  # iPartId : INT
    Fiddle::TYPE_INT,  # iStateId : INT
    Fiddle::TYPE_VOIDP,  # pszText : LPCWSTR
    Fiddle::TYPE_INT,  # cchCharCount : INT
    -Fiddle::TYPE_INT,  # dwTextFlags : DRAW_TEXT_FORMAT
    Fiddle::TYPE_VOIDP,  # pBoundingRect : RECT* optional
    Fiddle::TYPE_VOIDP,  # pExtentRect : RECT* out
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("UXTHEME.dll")]
public static extern int GetThemeTextExtent(IntPtr hTheme, IntPtr hdc, int iPartId, int iStateId, [MarshalAs(UnmanagedType.LPWStr)] string pszText, int cchCharCount, uint dwTextFlags, IntPtr pBoundingRect, IntPtr pExtentRect);
"@
$api = Add-Type -MemberDefinition $sig -Name 'UXTHEME_GetThemeTextExtent' -Namespace Win32 -PassThru
# $api::GetThemeTextExtent(hTheme, hdc, iPartId, iStateId, pszText, cchCharCount, dwTextFlags, pBoundingRect, pExtentRect)

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

出力引数:

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