ホーム › Graphics.Gdi › TTDeleteEmbeddedFont

TTDeleteEmbeddedFont

関数

読み込んだ埋め込みフォントを解放して削除する。

DLLt2embed.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// t2embed.dll
#include <windows.h>

INT TTDeleteEmbeddedFont(
    HANDLE hFontReference,
    DWORD ulFlags,
    DWORD* pulStatus
);

パラメーター

名前

型

方向

説明

hFontReference

HANDLE

TTLoadEmbeddedFont 関数で提供された、フォントを識別するハンドル。

ulFlags

DWORD

フォント削除オプションを指定するフラグ。現在、このフラグにはゼロまたは次の値を設定できます。

値	意味
TTDELETE_DONTREMOVEFONT	インストールされたフォントをシステムから削除しませんが、埋め込みフォント構造体が以前に占有していたメモリは解放します。

pulStatus

DWORD*

out

現在は未定義です。

戻り値の型: INT

公式ドキュメント

埋め込みフォント hFontReference が使用しているメモリを解放します。

戻り値

成功した場合、TTDeleteEmbeddedFont は E_NONE の値を返します。

埋め込みフォント構造体が占有していたメモリはクリアされます。既定では、hFontReference が示すフォントもシステムから永続的に削除(アンインストールおよび削除)されます。

それ以外の場合は、Embedding-Function Error Messages に記載されているエラーコードを返します。

解説(Remarks)

埋め込み権限によってフォントをユーザーのシステムに永続的にインストールすることが許可されていない場合、クライアントはこの関数を呼び出してフォントを削除する責任があります。

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

各言語での呼び出し定義

// t2embed.dll
#include <windows.h>

INT TTDeleteEmbeddedFont(
    HANDLE hFontReference,
    DWORD ulFlags,
    DWORD* pulStatus
);

[DllImport("t2embed.dll", ExactSpelling = true)]
static extern int TTDeleteEmbeddedFont(
    IntPtr hFontReference,   // HANDLE
    uint ulFlags,   // DWORD
    out uint pulStatus   // DWORD* out
);

<DllImport("t2embed.dll", ExactSpelling:=True)>
Public Shared Function TTDeleteEmbeddedFont(
    hFontReference As IntPtr,   ' HANDLE
    ulFlags As UInteger,   ' DWORD
    <Out> ByRef pulStatus As UInteger   ' DWORD* out
) As Integer
End Function

' hFontReference : HANDLE
' ulFlags : DWORD
' pulStatus : DWORD* out
Declare PtrSafe Function TTDeleteEmbeddedFont Lib "t2embed" ( _
    ByVal hFontReference As LongPtr, _
    ByVal ulFlags As Long, _
    ByRef pulStatus As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

TTDeleteEmbeddedFont = ctypes.windll.t2embed.TTDeleteEmbeddedFont
TTDeleteEmbeddedFont.restype = ctypes.c_int
TTDeleteEmbeddedFont.argtypes = [
    wintypes.HANDLE,  # hFontReference : HANDLE
    wintypes.DWORD,  # ulFlags : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pulStatus : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('t2embed.dll')
TTDeleteEmbeddedFont = Fiddle::Function.new(
  lib['TTDeleteEmbeddedFont'],
  [
    Fiddle::TYPE_VOIDP,  # hFontReference : HANDLE
    -Fiddle::TYPE_INT,  # ulFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pulStatus : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "t2embed")]
extern "system" {
    fn TTDeleteEmbeddedFont(
        hFontReference: *mut core::ffi::c_void,  // HANDLE
        ulFlags: u32,  // DWORD
        pulStatus: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("t2embed.dll")]
public static extern int TTDeleteEmbeddedFont(IntPtr hFontReference, uint ulFlags, out uint pulStatus);
"@
$api = Add-Type -MemberDefinition $sig -Name 't2embed_TTDeleteEmbeddedFont' -Namespace Win32 -PassThru
# $api::TTDeleteEmbeddedFont(hFontReference, ulFlags, pulStatus)

#uselib "t2embed.dll"
#func global TTDeleteEmbeddedFont "TTDeleteEmbeddedFont" sptr, sptr, sptr
; TTDeleteEmbeddedFont hFontReference, ulFlags, varptr(pulStatus)   ; 戻り値は stat
; hFontReference : HANDLE -> "sptr"
; ulFlags : DWORD -> "sptr"
; pulStatus : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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