ホーム › Graphics.Gdi › EnumFontFamiliesExA

EnumFontFamiliesExA

関数

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

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

シグネチャ

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

INT EnumFontFamiliesExA(
    HDC hdc,
    LOGFONTA* lpLogfont,
    FONTENUMPROCA lpProc,
    LPARAM lParam,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

hdc

HDC

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

lpLogfont

LOGFONTA*

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

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

lpProc

FONTENUMPROCA

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

lParam

LPARAM

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

dwFlags

DWORD

このパラメーターは使用されず、ゼロでなければなりません。

戻り値の型: INT

公式ドキュメント

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

戻り値

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

解説(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 構造体にスクリプトフィールドが含まれていることです。

注意点として、lfCharSet と lfFaceName の値に基づき、EnumFontFamiliesEx は、フォント内に存在する個別の文字セットの数だけ同じフォントを繰り返し列挙します。これにより、ユーザーにとって負担となる膨大なフォントの一覧が生成される可能性があります。たとえば、Century Schoolbook フォントは、バルト言語、欧文、ギリシャ語、トルコ語、キリル文字の各文字セットに対して表示されることがあります。これを避けるため、アプリケーションはフォントの一覧をフィルタリングするべきです。

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

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

メモ

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

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

INT EnumFontFamiliesExA(
    HDC hdc,
    LOGFONTA* lpLogfont,
    FONTENUMPROCA lpProc,
    LPARAM lParam,
    DWORD dwFlags
);

[DllImport("GDI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int EnumFontFamiliesExA(
    IntPtr hdc,   // HDC
    IntPtr lpLogfont,   // LOGFONTA*
    IntPtr lpProc,   // FONTENUMPROCA
    IntPtr lParam,   // LPARAM
    uint dwFlags   // DWORD
);

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

' hdc : HDC
' lpLogfont : LOGFONTA*
' lpProc : FONTENUMPROCA
' lParam : LPARAM
' dwFlags : DWORD
Declare PtrSafe Function EnumFontFamiliesExA Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lpLogfont As LongPtr, _
    ByVal lpProc As LongPtr, _
    ByVal lParam As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
EnumFontFamiliesExA = Fiddle::Function.new(
  lib['EnumFontFamiliesExA'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # lpLogfont : LOGFONTA*
    Fiddle::TYPE_VOIDP,  # lpProc : FONTENUMPROCA
    Fiddle::TYPE_INTPTR_T,  # lParam : LPARAM
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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