ホーム › Graphics.Gdi › TTIsEmbeddingEnabled

TTIsEmbeddingEnabled

関数

現在選択フォントの埋め込みが有効かどうかを判定する。

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

シグネチャ

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

INT TTIsEmbeddingEnabled(
    HDC hDC,
    BOOL* pbEnabled
);

パラメーター

名前	型	方向	説明
hDC	HDC	in	デバイスコンテキストのハンドル。
pbEnabled	BOOL*	out	関数の完了時に設定されるブール値へのポインター。ゼロ以外の値は、そのフォントが書体除外リストに含まれておらず、したがって競合なく埋め込み可能であることを示します。

戻り値の型: INT

公式ドキュメント

書体除外リストに指定したフォントが含まれているかどうかを判定します。

戻り値

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

パラメーター pbEnabled には、デバイスコンテキスト内で埋め込みが現在有効になっているかどうかを示すブール値が格納されます。

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

解説(Remarks)

指定したフォントがリストに含まれている場合、クライアントはそのフォントを埋め込むべきではありません。

除外リストに関する追加情報については、TTEnableEmbeddingForFacename の「解説」セクションを参照してください。

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

各言語での呼び出し定義

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

INT TTIsEmbeddingEnabled(
    HDC hDC,
    BOOL* pbEnabled
);

[DllImport("t2embed.dll", ExactSpelling = true)]
static extern int TTIsEmbeddingEnabled(
    IntPtr hDC,   // HDC
    out bool pbEnabled   // BOOL* out
);

<DllImport("t2embed.dll", ExactSpelling:=True)>
Public Shared Function TTIsEmbeddingEnabled(
    hDC As IntPtr,   ' HDC
    <Out> ByRef pbEnabled As Boolean   ' BOOL* out
) As Integer
End Function

' hDC : HDC
' pbEnabled : BOOL* out
Declare PtrSafe Function TTIsEmbeddingEnabled Lib "t2embed" ( _
    ByVal hDC As LongPtr, _
    ByRef pbEnabled As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

TTIsEmbeddingEnabled = ctypes.windll.t2embed.TTIsEmbeddingEnabled
TTIsEmbeddingEnabled.restype = ctypes.c_int
TTIsEmbeddingEnabled.argtypes = [
    wintypes.HANDLE,  # hDC : HDC
    ctypes.c_void_p,  # pbEnabled : BOOL* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('t2embed.dll')
TTIsEmbeddingEnabled = Fiddle::Function.new(
  lib['TTIsEmbeddingEnabled'],
  [
    Fiddle::TYPE_VOIDP,  # hDC : HDC
    Fiddle::TYPE_VOIDP,  # pbEnabled : BOOL* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "t2embed")]
extern "system" {
    fn TTIsEmbeddingEnabled(
        hDC: *mut core::ffi::c_void,  // HDC
        pbEnabled: *mut i32  // BOOL* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("t2embed.dll")]
public static extern int TTIsEmbeddingEnabled(IntPtr hDC, out bool pbEnabled);
"@
$api = Add-Type -MemberDefinition $sig -Name 't2embed_TTIsEmbeddingEnabled' -Namespace Win32 -PassThru
# $api::TTIsEmbeddingEnabled(hDC, pbEnabled)

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

出力引数:

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