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

RemoveFontResourceA

関数
追加したフォントリソースをシステムから削除する。
DLLGDI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL RemoveFontResourceA(
    LPCSTR lpFileName
);

パラメーター

名前方向説明
lpFileNameLPCSTRinフォントリソースファイルの名前を表す、null で終わる文字列へのポインター。

戻り値の型: BOOL

公式ドキュメント

RemoveFontResource 関数は、指定されたファイル内のフォントをシステムフォントテーブルから削除します。(ANSI)

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗すると、戻り値は 0 になります。

解説(Remarks)

アプリがシステムフォントテーブルにフォントを追加または削除する場合は、システム内のすべてのトップレベルウィンドウに WM_FONTCHANGE メッセージを送信して、その変更を他のウィンドウに通知することをお勧めします。アプリは、hwnd パラメーターを HWND_BROADCAST に設定して SendMessage 関数を呼び出すことで、このメッセージを送信します。

フォントへの未解決の参照が残っている場合、関連するリソースは、いずれのデバイスコンテキストもそのフォントを使用しなくなるまでロードされたままになります。さらに、そのフォントがフォントレジストリ(HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Fonts)に登録されており、%windir%\fonts\ フォルダー以外の場所にインストールされている場合、他のアクティブなセッション(セッション 0 を含む)にロードされることがあります。

未解決の参照を持つフォントを含む既存のフォントファイルを置き換えようとすると、RemoveFontResource を呼び出した後でも、元のフォントが使用中であるために削除できないことを示すエラーが発生する場合があります。アプリでフォントファイルの置き換えが必要な場合は、元のフォントの参照カウントを 0 にするために、次のサンプルコードに示すように RemoveFontResource をループ内で呼び出してください。それでもエラーが発生し続ける場合は、フォントファイルが他のセッションでロードされたままであることを示しています。フォントがフォントレジストリに登録されていないことを確認し、システムを再起動して、すべてのセッションからフォントがアンロードされるようにしてください。

注意 元のフォントファイルが使用中のアプリは、引き続き元のファイルにアクセスでき、フォントが再ロードされるまで新しいフォントを使用しません。フォントを再ロードするには AddFontResource を呼び出してください。次のサンプルコードに示すように、RemoveFontResource の呼び出しが成功した回数と同じ回数だけ AddFontResource を呼び出すことをお勧めします。

int i = 0;
while( RemoveFontResource( FontFile ) )
{
    i++;
}

// TODO: Replace font file

while( i-- )
{
    AddFontResource( FontFile );
}
メモ

wingdi.h ヘッダーは、RemoveFontResource を、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>

BOOL RemoveFontResourceA(
    LPCSTR lpFileName
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool RemoveFontResourceA(
    [MarshalAs(UnmanagedType.LPStr)] string lpFileName   // LPCSTR
);
<DllImport("GDI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RemoveFontResourceA(
    <MarshalAs(UnmanagedType.LPStr)> lpFileName As String   ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpFileName : LPCSTR
Declare PtrSafe Function RemoveFontResourceA Lib "gdi32" ( _
    ByVal lpFileName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RemoveFontResourceA = ctypes.windll.gdi32.RemoveFontResourceA
RemoveFontResourceA.restype = wintypes.BOOL
RemoveFontResourceA.argtypes = [
    wintypes.LPCSTR,  # lpFileName : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
RemoveFontResourceA = Fiddle::Function.new(
  lib['RemoveFontResourceA'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn RemoveFontResourceA(
        lpFileName: *const u8  // LPCSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", CharSet = CharSet.Ansi)]
public static extern bool RemoveFontResourceA([MarshalAs(UnmanagedType.LPStr)] string lpFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_RemoveFontResourceA' -Namespace Win32 -PassThru
# $api::RemoveFontResourceA(lpFileName)
#uselib "GDI32.dll"
#func global RemoveFontResourceA "RemoveFontResourceA" sptr
; RemoveFontResourceA lpFileName   ; 戻り値は stat
; lpFileName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "GDI32.dll"
#cfunc global RemoveFontResourceA "RemoveFontResourceA" str
; res = RemoveFontResourceA(lpFileName)
; lpFileName : LPCSTR -> "str"
; BOOL RemoveFontResourceA(LPCSTR lpFileName)
#uselib "GDI32.dll"
#cfunc global RemoveFontResourceA "RemoveFontResourceA" str
; res = RemoveFontResourceA(lpFileName)
; lpFileName : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procRemoveFontResourceA = gdi32.NewProc("RemoveFontResourceA")
)

// lpFileName (LPCSTR)
r1, _, err := procRemoveFontResourceA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFileName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function RemoveFontResourceA(
  lpFileName: PAnsiChar   // LPCSTR
): BOOL; stdcall;
  external 'GDI32.dll' name 'RemoveFontResourceA';
result := DllCall("GDI32\RemoveFontResourceA"
    , "AStr", lpFileName   ; LPCSTR
    , "Int")   ; return: BOOL
●RemoveFontResourceA(lpFileName) = DLL("GDI32.dll", "bool RemoveFontResourceA(char*)")
# 呼び出し: RemoveFontResourceA(lpFileName)
# lpFileName : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "gdi32" fn RemoveFontResourceA(
    lpFileName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;
proc RemoveFontResourceA(
    lpFileName: cstring  # LPCSTR
): int32 {.importc: "RemoveFontResourceA", stdcall, dynlib: "GDI32.dll".}
pragma(lib, "gdi32");
extern(Windows)
int RemoveFontResourceA(
    const(char)* lpFileName   // LPCSTR
);
ccall((:RemoveFontResourceA, "GDI32.dll"), stdcall, Int32,
      (Cstring,),
      lpFileName)
# lpFileName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t RemoveFontResourceA(
    const char* lpFileName);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.RemoveFontResourceA(lpFileName)
-- lpFileName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const RemoveFontResourceA = lib.func('__stdcall', 'RemoveFontResourceA', 'int32_t', ['str']);
// RemoveFontResourceA(lpFileName)
// lpFileName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  RemoveFontResourceA: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.RemoveFontResourceA(lpFileName)
// lpFileName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t RemoveFontResourceA(
    const char* lpFileName);
C, "GDI32.dll");
// $ffi->RemoveFontResourceA(lpFileName);
// lpFileName : LPCSTR
// 構造体/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.ASCII_OPTIONS);
    boolean RemoveFontResourceA(
        String lpFileName   // LPCSTR
    );
}
@[Link("gdi32")]
lib LibGDI32
  fun RemoveFontResourceA = RemoveFontResourceA(
    lpFileName : UInt8*   # LPCSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RemoveFontResourceANative = Int32 Function(Pointer<Utf8>);
typedef RemoveFontResourceADart = int Function(Pointer<Utf8>);
final RemoveFontResourceA = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<RemoveFontResourceANative, RemoveFontResourceADart>('RemoveFontResourceA');
// lpFileName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RemoveFontResourceA(
  lpFileName: PAnsiChar   // LPCSTR
): BOOL; stdcall;
  external 'GDI32.dll' name 'RemoveFontResourceA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RemoveFontResourceA"
  c_RemoveFontResourceA :: CString -> IO CInt
-- lpFileName : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let removefontresourcea =
  foreign "RemoveFontResourceA"
    (string @-> returning int32_t)
(* lpFileName : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("RemoveFontResourceA" remove-font-resource-a :convention :stdcall) :int32
  (lp-file-name :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RemoveFontResourceA = Win32::API::More->new('GDI32',
    'BOOL RemoveFontResourceA(LPCSTR lpFileName)');
# my $ret = $RemoveFontResourceA->Call($lpFileName);
# lpFileName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API
公式の関連項目