ホーム › Graphics.Gdi › EnumFontFamiliesExW

EnumFontFamiliesExW

関数

条件に一致するフォントを列挙しコールバックに渡す。

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

シグネチャ

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

INT EnumFontFamiliesExW(
    HDC hdc,
    LOGFONTW* lpLogfont,
    FONTENUMPROCW lpProc,
    LPARAM lParam,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

hdc

HDC

フォントを列挙するデバイスコンテキストへのハンドル。

lpLogfont

LOGFONTW*

列挙するフォントに関する情報を含む LOGFONT 構造体へのポインター。この関数は次のメンバーを調べます。

メンバー	説明
lfCharSet	DEFAULT_CHARSET に設定されている場合、関数はすべての文字セット内のすべての一意な名前を持つフォントを列挙します。(同じ名前のフォントが2つある場合は、1つだけが列挙されます。) 有効な文字セット値に設定されている場合、関数は指定された文字セット内のフォントのみを列挙します。
lfFaceName	空の文字列に設定されている場合、関数は利用可能な各書体名について1つのフォントを列挙します。有効な書体名に設定されている場合、関数は指定された名前を持つすべてのフォントを列挙します。
lfPitchAndFamily	オペレーティングシステムのすべての言語バージョンにおいて、ゼロに設定する必要があります。

lpProc

FONTENUMPROCW

アプリケーション定義のコールバック関数へのポインター。詳細については、EnumFontFamExProc 関数を参照してください。

lParam

LPARAM

アプリケーション定義の値。関数はこの値をフォント情報とともにコールバック関数に渡します。

dwFlags

DWORD

このパラメーターは使用されず、ゼロにする必要があります。

戻り値の型: INT

公式ドキュメント

EnumFontFamiliesEx 関数は、LOGFONT 構造体で指定されたフォントの特性に一致する、システム内のすべての一意な名前を持つフォントを列挙します。EnumFontFamiliesEx は、書体名、文字セット、またはその両方に基づいてフォントを列挙します。(Unicode)

戻り値

戻り値は、コールバック関数が最後に返した値です。この値は、指定されたデバイスで利用可能なフォントファミリーによって異なります。

解説(Remarks)

EnumFontFamiliesEx 関数は、文字セットを識別するためにタグ付きの書体名を使用しません。代わりに、常に正しい書体名と個別の文字セット値をコールバック関数に渡します。関数は、LOGFONT 構造体の lfCharSet メンバーと lfFaceName メンバーの値に基づいてフォントを列挙します。

EnumFontFamilies と同様に、EnumFontFamiliesEx はすべてのフォントスタイルを列挙します。フォントのすべてのスタイルが同じ文字セットをカバーするわけではありません。たとえば、Fontorama Bold は ANSI、ギリシャ語、キリル文字の文字を含んでいるかもしれませんが、Fontorama Italic は ANSI 文字のみを含んでいるかもしれません。このため、指定されたフォントが特定の文字セット (ANSI 文字セットであっても) をカバーしていると仮定しないことが最善です。次の表は、lfCharSet と lfFaceName の値のさまざまな組み合わせの結果を示しています。

値	意味
lfCharSet = DEFAULT_CHARSET lfFaceName = '\0'	すべての文字セット内のすべての一意な名前を持つフォントを列挙します。同じ名前のフォントが2つある場合は、1つだけが列挙されます。
lfCharSet = DEFAULT_CHARSET lfFaceName = 特定のフォント	特定のフォントのすべての文字セットとスタイルを列挙します。
lfCharSet = 特定の文字セット lfFaceName = '\0'	特定の文字セット内のすべてのフォントのすべてのスタイルを列挙します。
lfCharSet = 特定の文字セット lfFaceName = 特定のフォント	特定の文字セット内のフォントのすべてのスタイルを列挙します。

次のコードサンプルは、これらの値の使用方法を示しています。


// To enumerate all styles and charsets of all fonts: 
lf.lfFaceName[0] = '\0';
lf.lfCharSet = DEFAULT_CHARSET;
HRESULT hr;

// To enumerate all styles and character sets of the Arial font: 
hr = StringCchCopy( (LPSTR)lf.lfFaceName, LF_FACESIZE, "Arial" );
if (FAILED(hr))
{
// TODO: write error handler 
}

lf.lfCharSet = DEFAULT_CHARSET;


// To enumerate all styles of all fonts for the ANSI character set 
lf.lfFaceName[0] = '\0';
lf.lfCharSet = ANSI_CHARSET;

// To enumerate all styles of Arial font that cover the ANSI charset 
hr = StringCchCopy( (LPSTR)lf.lfFaceName, LF_FACESIZE, "Arial" );
if (FAILED(hr))
{
// TODO: write error handler 
}

lf.lfCharSet = ANSI_CHARSET;

EnumFontFamilies と EnumFontFamiliesEx のコールバック関数は非常に似ています。主な違いは、ENUMLOGFONTEX 構造体に script フィールドが含まれていることです。

注意として、lfCharSet と lfFaceName の値に基づき、EnumFontFamiliesEx は、フォント内に存在する個別の文字セットの数だけ同じフォントを列挙します。これにより、ユーザーにとって負担となりうる広範なフォントのリストが作成される可能性があります。たとえば、Century Schoolbook フォントは、バルト語、欧文、ギリシャ語、トルコ語、キリル文字の各文字セットについて表示されることがあります。これを避けるために、アプリケーションはフォントのリストをフィルター処理する必要があります。

多くの東アジア言語のフォントには、英語名とローカライズされた名前の2つの書体名があります。EnumFonts、EnumFontFamilies、および EnumFontFamiliesEx は、システムロケールがフォントの言語と一致しない場合、英語の書体名を返します。

デバイスコンテキストのグラフィックスモードが SetGraphicsMode 関数を使用して GM_ADVANCED に設定され、DEVICE_FONTTYPE フラグが FontType パラメーターに渡された場合、この関数はシステム上の Type 1 および OpenType フォントのリストを返します。グラフィックスモードが GM_ADVANCED に設定されていない場合、この関数はシステム上の Type 1、OpenType、および TrueType フォントのリストを返します。

メモ

wingdi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして EnumFontFamiliesEx を定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致につながる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

INT EnumFontFamiliesExW(
    HDC hdc,
    LOGFONTW* lpLogfont,
    FONTENUMPROCW lpProc,
    LPARAM lParam,
    DWORD dwFlags
);

[DllImport("GDI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int EnumFontFamiliesExW(
    IntPtr hdc,   // HDC
    IntPtr lpLogfont,   // LOGFONTW*
    IntPtr lpProc,   // FONTENUMPROCW
    IntPtr lParam,   // LPARAM
    uint dwFlags   // DWORD
);

<DllImport("GDI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function EnumFontFamiliesExW(
    hdc As IntPtr,   ' HDC
    lpLogfont As IntPtr,   ' LOGFONTW*
    lpProc As IntPtr,   ' FONTENUMPROCW
    lParam As IntPtr,   ' LPARAM
    dwFlags As UInteger   ' DWORD
) As Integer
End Function

' hdc : HDC
' lpLogfont : LOGFONTW*
' lpProc : FONTENUMPROCW
' lParam : LPARAM
' dwFlags : DWORD
Declare PtrSafe Function EnumFontFamiliesExW Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lpLogfont As LongPtr, _
    ByVal lpProc As LongPtr, _
    ByVal lParam As LongPtr, _
    ByVal dwFlags As Long) 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

EnumFontFamiliesExW = ctypes.windll.gdi32.EnumFontFamiliesExW
EnumFontFamiliesExW.restype = ctypes.c_int
EnumFontFamiliesExW.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_void_p,  # lpLogfont : LOGFONTW*
    ctypes.c_void_p,  # lpProc : FONTENUMPROCW
    ctypes.c_ssize_t,  # lParam : LPARAM
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
EnumFontFamiliesExW = Fiddle::Function.new(
  lib['EnumFontFamiliesExW'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # lpLogfont : LOGFONTW*
    Fiddle::TYPE_VOIDP,  # lpProc : FONTENUMPROCW
    Fiddle::TYPE_INTPTR_T,  # lParam : LPARAM
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "gdi32")]
extern "system" {
    fn EnumFontFamiliesExW(
        hdc: *mut core::ffi::c_void,  // HDC
        lpLogfont: *mut LOGFONTW,  // LOGFONTW*
        lpProc: *const core::ffi::c_void,  // FONTENUMPROCW
        lParam: isize,  // LPARAM
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll", CharSet = CharSet.Unicode)]
public static extern int EnumFontFamiliesExW(IntPtr hdc, IntPtr lpLogfont, IntPtr lpProc, IntPtr lParam, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_EnumFontFamiliesExW' -Namespace Win32 -PassThru
# $api::EnumFontFamiliesExW(hdc, lpLogfont, lpProc, lParam, dwFlags)

#uselib "GDI32.dll"
#func global EnumFontFamiliesExW "EnumFontFamiliesExW" wptr, wptr, wptr, wptr, wptr
; EnumFontFamiliesExW hdc, varptr(lpLogfont), lpProc, lParam, dwFlags   ; 戻り値は stat
; hdc : HDC -> "wptr"
; lpLogfont : LOGFONTW* -> "wptr"
; lpProc : FONTENUMPROCW -> "wptr"
; lParam : LPARAM -> "wptr"
; dwFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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