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

TTEnableEmbeddingForFacename

関数
指定した書体名のフォント埋め込みの有効無効を切り替える。
DLLt2embed.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT TTEnableEmbeddingForFacename(
    LPCSTR lpszFacename,
    BOOL bEnable
);

パラメーター

名前方向説明
lpszFacenameLPCSTRin書体除外リストに追加または削除するフォントのフェイス名へのポインター。
bEnableBOOLin書体除外リストに対する操作を制御するブール値。非ゼロの場合、フェイス名がリストから削除されます。ゼロの場合、フェイス名がリストに追加されます。

戻り値の型: INT

公式ドキュメント

書体除外リストにフェイス名を追加または削除します。

戻り値

成功した場合は E_NONE を返します。

lpszFacename で示されるフェイス名が書体除外リストに追加または削除されます。

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

解説(Remarks)

TTEnableEmbeddingForFacename 関数は、特定のフォントを埋め込めるかどうかを制御するために書体除外リストを使用します。このリストは、埋め込むべきでないすべてのフォントを識別し、単一のシステム上のすべてのオーサリングクライアントによって共有されます。

オーサリングクライアントは、書体除外リストを参照せずに(つまり TTEnableEmbeddingForFacename を使用せずに)フォントを埋め込むことができます。ドキュメントにフォントを埋め込むと、次のようなトレードオフが生じます。

さらに 2 つの関数 TTIsEmbeddingEnabledTTIsEmbeddingEnabledForFacename は、書体除外リストにアクセスして有効状態を提供します。

書体除外リストはレジストリキー HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Shared Tools\t2embed に格納されます。既定の書体除外リストには、Microsoft Windows のコアフォントを表す次の名前付き値エントリが含まれている必要があります。

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

各言語での呼び出し定義

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

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

TTEnableEmbeddingForFacename = ctypes.windll.t2embed.TTEnableEmbeddingForFacename
TTEnableEmbeddingForFacename.restype = ctypes.c_int
TTEnableEmbeddingForFacename.argtypes = [
    wintypes.LPCSTR,  # lpszFacename : LPCSTR
    wintypes.BOOL,  # bEnable : BOOL
]
require 'fiddle'
require 'fiddle/import'

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

var (
	t2embed = windows.NewLazySystemDLL("t2embed.dll")
	procTTEnableEmbeddingForFacename = t2embed.NewProc("TTEnableEmbeddingForFacename")
)

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

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

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

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

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

(cffi:defcfun ("TTEnableEmbeddingForFacename" ttenable-embedding-for-facename :convention :stdcall) :int32
  (lpsz-facename :string)   ; LPCSTR
  (b-enable :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TTEnableEmbeddingForFacename = Win32::API::More->new('t2embed',
    'int TTEnableEmbeddingForFacename(LPCSTR lpszFacename, BOOL bEnable)');
# my $ret = $TTEnableEmbeddingForFacename->Call($lpszFacename, $bEnable);
# lpszFacename : LPCSTR -> LPCSTR
# bEnable : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目