GetTextFaceA

関数

現在選択中のフォントの書体名を取得する(ANSI版)。

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

シグネチャ

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

INT GetTextFaceA(
    HDC hdc,
    INT c,
    LPSTR lpName   // optional
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。
c	INT	in	lpFaceName が指すバッファの長さ。ANSI 関数では BYTE 数、Unicode 関数では WORD 数です。なお、ANSI 関数では SBCS コードページの文字は 1 文字あたり 1 バイトですが、DBCS コードページのほとんどの文字は 2 バイトを使用します。Unicode 関数では、現在定義されているほとんどの Unicode 文字(基本多言語面 (BMP) に含まれる文字)は 1 WORD ですが、Unicode サロゲートは 2 WORD です。
lpName	LPSTR	outoptional	書体名を受け取るバッファへのポインター。このパラメーターが NULL の場合、関数は終端の null 文字を含む名前の文字数を返します。

戻り値の型: INT

公式ドキュメント

GetTextFace 関数は、指定したデバイスコンテキストに選択されているフォントの書体名を取得します。(ANSI)

戻り値

関数が成功すると、戻り値はバッファにコピーされた文字数です。

関数が失敗すると、戻り値は 0 です。

解説(Remarks)

書体名は null で終わる文字列としてコピーされます。

名前が nCount パラメーターで指定された文字数より長い場合、名前は切り詰められます。

メモ

wingdi.h ヘッダーは GetTextFace を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetTextFaceA(
    HDC hdc,
    INT c,
    LPSTR lpName   // optional
);

[DllImport("GDI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int GetTextFaceA(
    IntPtr hdc,   // HDC
    int c,   // INT
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpName   // LPSTR optional, out
);

<DllImport("GDI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetTextFaceA(
    hdc As IntPtr,   ' HDC
    c As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPStr)> lpName As System.Text.StringBuilder   ' LPSTR optional, out
) As Integer
End Function

' hdc : HDC
' c : INT
' lpName : LPSTR optional, out
Declare PtrSafe Function GetTextFaceA Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal c As Long, _
    ByVal lpName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetTextFaceA = ctypes.windll.gdi32.GetTextFaceA
GetTextFaceA.restype = ctypes.c_int
GetTextFaceA.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_int,  # c : INT
    wintypes.LPSTR,  # lpName : LPSTR optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetTextFaceA = Fiddle::Function.new(
  lib['GetTextFaceA'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_INT,  # c : INT
    Fiddle::TYPE_VOIDP,  # lpName : LPSTR optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetTextFaceA(
        hdc: *mut core::ffi::c_void,  // HDC
        c: i32,  // INT
        lpName: *mut u8  // LPSTR optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll", CharSet = CharSet.Ansi)]
public static extern int GetTextFaceA(IntPtr hdc, int c, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetTextFaceA' -Namespace Win32 -PassThru
# $api::GetTextFaceA(hdc, c, lpName)

#uselib "GDI32.dll"
#func global GetTextFaceA "GetTextFaceA" sptr, sptr, sptr
; GetTextFaceA hdc, c, varptr(lpName)   ; 戻り値は stat
; hdc : HDC -> "sptr"
; c : INT -> "sptr"
; lpName : LPSTR optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global GetTextFaceA "GetTextFaceA" sptr, int, var
; res = GetTextFaceA(hdc, c, lpName)
; hdc : HDC -> "sptr"
; c : INT -> "int"
; lpName : LPSTR optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global GetTextFaceA "GetTextFaceA" sptr, int, sptr
; res = GetTextFaceA(hdc, c, varptr(lpName))
; hdc : HDC -> "sptr"
; c : INT -> "int"
; lpName : LPSTR optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。