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

GetOutlineTextMetricsW

関数
アウトラインフォントのテキストメトリックを取得する。
DLLGDI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// GDI32.dll  (Unicode / -W)
#include <windows.h>

DWORD GetOutlineTextMetricsW(
    HDC hdc,
    DWORD cjCopy,
    OUTLINETEXTMETRICW* potm   // optional
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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  (Unicode / -W)
#include <windows.h>

DWORD GetOutlineTextMetricsW(
    HDC hdc,
    DWORD cjCopy,
    OUTLINETEXTMETRICW* potm   // optional
);
[DllImport("GDI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint GetOutlineTextMetricsW(
    IntPtr hdc,   // HDC
    uint cjCopy,   // DWORD
    IntPtr potm   // OUTLINETEXTMETRICW* optional, out
);
<DllImport("GDI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetOutlineTextMetricsW(
    hdc As IntPtr,   ' HDC
    cjCopy As UInteger,   ' DWORD
    potm As IntPtr   ' OUTLINETEXTMETRICW* optional, out
) As UInteger
End Function
' hdc : HDC
' cjCopy : DWORD
' potm : OUTLINETEXTMETRICW* optional, out
Declare PtrSafe Function GetOutlineTextMetricsW Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal cjCopy As Long, _
    ByVal potm As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetOutlineTextMetricsW = ctypes.windll.gdi32.GetOutlineTextMetricsW
GetOutlineTextMetricsW.restype = wintypes.DWORD
GetOutlineTextMetricsW.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.DWORD,  # cjCopy : DWORD
    ctypes.c_void_p,  # potm : OUTLINETEXTMETRICW* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetOutlineTextMetricsW = Fiddle::Function.new(
  lib['GetOutlineTextMetricsW'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    -Fiddle::TYPE_INT,  # cjCopy : DWORD
    Fiddle::TYPE_VOIDP,  # potm : OUTLINETEXTMETRICW* optional, out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "gdi32")]
extern "system" {
    fn GetOutlineTextMetricsW(
        hdc: *mut core::ffi::c_void,  // HDC
        cjCopy: u32,  // DWORD
        potm: *mut OUTLINETEXTMETRICW  // OUTLINETEXTMETRICW* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("GDI32.dll", CharSet = CharSet.Unicode)]
public static extern uint GetOutlineTextMetricsW(IntPtr hdc, uint cjCopy, IntPtr potm);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetOutlineTextMetricsW' -Namespace Win32 -PassThru
# $api::GetOutlineTextMetricsW(hdc, cjCopy, potm)
#uselib "GDI32.dll"
#func global GetOutlineTextMetricsW "GetOutlineTextMetricsW" wptr, wptr, wptr
; GetOutlineTextMetricsW hdc, cjCopy, varptr(potm)   ; 戻り値は stat
; hdc : HDC -> "wptr"
; cjCopy : DWORD -> "wptr"
; potm : OUTLINETEXTMETRICW* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "GDI32.dll"
#cfunc global GetOutlineTextMetricsW "GetOutlineTextMetricsW" sptr, int, var
; res = GetOutlineTextMetricsW(hdc, cjCopy, potm)
; hdc : HDC -> "sptr"
; cjCopy : DWORD -> "int"
; potm : OUTLINETEXTMETRICW* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetOutlineTextMetricsW(HDC hdc, DWORD cjCopy, OUTLINETEXTMETRICW* potm)
#uselib "GDI32.dll"
#cfunc global GetOutlineTextMetricsW "GetOutlineTextMetricsW" intptr, int, var
; res = GetOutlineTextMetricsW(hdc, cjCopy, potm)
; hdc : HDC -> "intptr"
; cjCopy : DWORD -> "int"
; potm : OUTLINETEXTMETRICW* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procGetOutlineTextMetricsW = gdi32.NewProc("GetOutlineTextMetricsW")
)

// hdc (HDC), cjCopy (DWORD), potm (OUTLINETEXTMETRICW* optional, out)
r1, _, err := procGetOutlineTextMetricsW.Call(
	uintptr(hdc),
	uintptr(cjCopy),
	uintptr(potm),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetOutlineTextMetricsW(
  hdc: THandle;   // HDC
  cjCopy: DWORD;   // DWORD
  potm: Pointer   // OUTLINETEXTMETRICW* optional, out
): DWORD; stdcall;
  external 'GDI32.dll' name 'GetOutlineTextMetricsW';
result := DllCall("GDI32\GetOutlineTextMetricsW"
    , "Ptr", hdc   ; HDC
    , "UInt", cjCopy   ; DWORD
    , "Ptr", potm   ; OUTLINETEXTMETRICW* optional, out
    , "UInt")   ; return: DWORD
●GetOutlineTextMetricsW(hdc, cjCopy, potm) = DLL("GDI32.dll", "dword GetOutlineTextMetricsW(void*, dword, void*)")
# 呼び出し: GetOutlineTextMetricsW(hdc, cjCopy, potm)
# hdc : HDC -> "void*"
# cjCopy : DWORD -> "dword"
# potm : OUTLINETEXTMETRICW* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "gdi32" fn GetOutlineTextMetricsW(
    hdc: ?*anyopaque, // HDC
    cjCopy: u32, // DWORD
    potm: [*c]OUTLINETEXTMETRICW // OUTLINETEXTMETRICW* optional, out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetOutlineTextMetricsW(
    hdc: pointer,  # HDC
    cjCopy: uint32,  # DWORD
    potm: ptr OUTLINETEXTMETRICW  # OUTLINETEXTMETRICW* optional, out
): uint32 {.importc: "GetOutlineTextMetricsW", stdcall, dynlib: "GDI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "gdi32");
extern(Windows)
uint GetOutlineTextMetricsW(
    void* hdc,   // HDC
    uint cjCopy,   // DWORD
    OUTLINETEXTMETRICW* potm   // OUTLINETEXTMETRICW* optional, out
);
ccall((:GetOutlineTextMetricsW, "GDI32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32, Ptr{OUTLINETEXTMETRICW}),
      hdc, cjCopy, potm)
# hdc : HDC -> Ptr{Cvoid}
# cjCopy : DWORD -> UInt32
# potm : OUTLINETEXTMETRICW* optional, out -> Ptr{OUTLINETEXTMETRICW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetOutlineTextMetricsW(
    void* hdc,
    uint32_t cjCopy,
    void* potm);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.GetOutlineTextMetricsW(hdc, cjCopy, potm)
-- hdc : HDC
-- cjCopy : DWORD
-- potm : OUTLINETEXTMETRICW* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const GetOutlineTextMetricsW = lib.func('__stdcall', 'GetOutlineTextMetricsW', 'uint32_t', ['void *', 'uint32_t', 'void *']);
// GetOutlineTextMetricsW(hdc, cjCopy, potm)
// hdc : HDC -> 'void *'
// cjCopy : DWORD -> 'uint32_t'
// potm : OUTLINETEXTMETRICW* optional, out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  GetOutlineTextMetricsW: { parameters: ["pointer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.GetOutlineTextMetricsW(hdc, cjCopy, potm)
// hdc : HDC -> "pointer"
// cjCopy : DWORD -> "u32"
// potm : OUTLINETEXTMETRICW* optional, out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetOutlineTextMetricsW(
    void* hdc,
    uint32_t cjCopy,
    void* potm);
C, "GDI32.dll");
// $ffi->GetOutlineTextMetricsW(hdc, cjCopy, potm);
// hdc : HDC
// cjCopy : DWORD
// potm : OUTLINETEXTMETRICW* optional, 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 Gdi32 extends StdCallLibrary {
    Gdi32 INSTANCE = Native.load("gdi32", Gdi32.class, W32APIOptions.UNICODE_OPTIONS);
    int GetOutlineTextMetricsW(
        Pointer hdc,   // HDC
        int cjCopy,   // DWORD
        Pointer potm   // OUTLINETEXTMETRICW* optional, out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("gdi32")]
lib LibGDI32
  fun GetOutlineTextMetricsW = GetOutlineTextMetricsW(
    hdc : Void*,   # HDC
    cjCopy : UInt32,   # DWORD
    potm : OUTLINETEXTMETRICW*   # OUTLINETEXTMETRICW* optional, out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetOutlineTextMetricsWNative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Void>);
typedef GetOutlineTextMetricsWDart = int Function(Pointer<Void>, int, Pointer<Void>);
final GetOutlineTextMetricsW = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<GetOutlineTextMetricsWNative, GetOutlineTextMetricsWDart>('GetOutlineTextMetricsW');
// hdc : HDC -> Pointer<Void>
// cjCopy : DWORD -> Uint32
// potm : OUTLINETEXTMETRICW* optional, out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetOutlineTextMetricsW(
  hdc: THandle;   // HDC
  cjCopy: DWORD;   // DWORD
  potm: Pointer   // OUTLINETEXTMETRICW* optional, out
): DWORD; stdcall;
  external 'GDI32.dll' name 'GetOutlineTextMetricsW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetOutlineTextMetricsW"
  c_GetOutlineTextMetricsW :: Ptr () -> Word32 -> Ptr () -> IO Word32
-- hdc : HDC -> Ptr ()
-- cjCopy : DWORD -> Word32
-- potm : OUTLINETEXTMETRICW* optional, out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getoutlinetextmetricsw =
  foreign "GetOutlineTextMetricsW"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* hdc : HDC -> (ptr void) *)
(* cjCopy : DWORD -> uint32_t *)
(* potm : OUTLINETEXTMETRICW* optional, out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("GetOutlineTextMetricsW" get-outline-text-metrics-w :convention :stdcall) :uint32
  (hdc :pointer)   ; HDC
  (cj-copy :uint32)   ; DWORD
  (potm :pointer))   ; OUTLINETEXTMETRICW* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetOutlineTextMetricsW = Win32::API::More->new('GDI32',
    'DWORD GetOutlineTextMetricsW(HANDLE hdc, DWORD cjCopy, LPVOID potm)');
# my $ret = $GetOutlineTextMetricsW->Call($hdc, $cjCopy, $potm);
# hdc : HDC -> HANDLE
# cjCopy : DWORD -> DWORD
# potm : OUTLINETEXTMETRICW* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型