ホーム › Graphics.Gdi › GetOutlineTextMetricsA

GetOutlineTextMetricsA

関数

アウトラインフォントのテキストメトリックを取得する。

DLLGDI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// GDI32.dll  (ANSI / -A)
#include <windows.h>

DWORD GetOutlineTextMetricsA(
    HDC hdc,
    DWORD cjCopy,
    OUTLINETEXTMETRICA* potm   // optional
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。
cjCopy	DWORD	in	テキストメトリックを受け取る配列のサイズ(バイト単位)。
potm	OUTLINETEXTMETRICA*	outoptional	OUTLINETEXTMETRIC 構造体へのポインター。このパラメーターが NULL の場合、関数は取得するメトリックデータに必要なバッファーのサイズを返します。

戻り値の型: DWORD

公式ドキュメント

GetOutlineTextMetrics 関数は、TrueType フォントのテキストメトリックを取得します。(ANSI)

戻り値

関数が成功した場合、戻り値は 0 以外の値、または必要なバッファーのサイズです。

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

解説(Remarks)

OUTLINETEXTMETRIC 構造体には、TrueType フォントに対して提供されるテキストメトリック情報のほとんど(TEXTMETRIC 構造体を含む)が格納されます。OUTLINETEXTMETRIC で返されるサイズは論理単位であり、現在のマッピングモードに依存します。

メモ

wingdi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetOutlineTextMetrics を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不一致が発生し、コンパイルエラーまたは実行時エラーを引き起こすおそれがあります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// GDI32.dll  (ANSI / -A)
#include <windows.h>

DWORD GetOutlineTextMetricsA(
    HDC hdc,
    DWORD cjCopy,
    OUTLINETEXTMETRICA* potm   // optional
);

[DllImport("GDI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint GetOutlineTextMetricsA(
    IntPtr hdc,   // HDC
    uint cjCopy,   // DWORD
    IntPtr potm   // OUTLINETEXTMETRICA* optional, out
);

<DllImport("GDI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetOutlineTextMetricsA(
    hdc As IntPtr,   ' HDC
    cjCopy As UInteger,   ' DWORD
    potm As IntPtr   ' OUTLINETEXTMETRICA* optional, out
) As UInteger
End Function

' hdc : HDC
' cjCopy : DWORD
' potm : OUTLINETEXTMETRICA* optional, out
Declare PtrSafe Function GetOutlineTextMetricsA Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal cjCopy As Long, _
    ByVal potm As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetOutlineTextMetricsA = ctypes.windll.gdi32.GetOutlineTextMetricsA
GetOutlineTextMetricsA.restype = wintypes.DWORD
GetOutlineTextMetricsA.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.DWORD,  # cjCopy : DWORD
    ctypes.c_void_p,  # potm : OUTLINETEXTMETRICA* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetOutlineTextMetricsA = Fiddle::Function.new(
  lib['GetOutlineTextMetricsA'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    -Fiddle::TYPE_INT,  # cjCopy : DWORD
    Fiddle::TYPE_VOIDP,  # potm : OUTLINETEXTMETRICA* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetOutlineTextMetricsA(
        hdc: *mut core::ffi::c_void,  // HDC
        cjCopy: u32,  // DWORD
        potm: *mut OUTLINETEXTMETRICA  // OUTLINETEXTMETRICA* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll", CharSet = CharSet.Ansi)]
public static extern uint GetOutlineTextMetricsA(IntPtr hdc, uint cjCopy, IntPtr potm);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetOutlineTextMetricsA' -Namespace Win32 -PassThru
# $api::GetOutlineTextMetricsA(hdc, cjCopy, potm)

#uselib "GDI32.dll"
#func global GetOutlineTextMetricsA "GetOutlineTextMetricsA" sptr, sptr, sptr
; GetOutlineTextMetricsA hdc, cjCopy, varptr(potm)   ; 戻り値は stat
; hdc : HDC -> "sptr"
; cjCopy : DWORD -> "sptr"
; potm : OUTLINETEXTMETRICA* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global GetOutlineTextMetricsA "GetOutlineTextMetricsA" sptr, int, var
; res = GetOutlineTextMetricsA(hdc, cjCopy, potm)
; hdc : HDC -> "sptr"
; cjCopy : DWORD -> "int"
; potm : OUTLINETEXTMETRICA* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global GetOutlineTextMetricsA "GetOutlineTextMetricsA" sptr, int, sptr
; res = GetOutlineTextMetricsA(hdc, cjCopy, varptr(potm))
; hdc : HDC -> "sptr"
; cjCopy : DWORD -> "int"
; potm : OUTLINETEXTMETRICA* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。