GetTextFaceW 関数 (wingdi.h)

[アーティクル]
03/13/2024

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

構文

int GetTextFaceW(
  [in]  HDC    hdc,
  [in]  int    c,
  [out] LPWSTR lpName
);

パラメーター

[in] hdc

デバイスコンテキストへのハンドル。

[in] c

lpFaceName が指すバッファーの長さ。 ANSI 関数の場合は BYTE カウントであり、Unicode 関数の場合は WORD カウントです。 ANSI 関数の場合、SBCS コードページの文字はそれぞれ 1 バイトになりますが、DBCS コードページのほとんどの文字は 2 バイトになります。Unicode 関数の場合、現在定義されているほとんどの Unicode 文字 (Basic 多言語プレーン (BMP) の文字) は 1 つの WORD で、Unicode サロゲートは 2 つの WORD です。

[out] lpName

書体名を受け取るバッファーへのポインター。このパラメーターが NULL の場合、関数は名前の文字数 (終端の null 文字を含む) を返します。

戻り値

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

関数が失敗した場合は、0 を返します。

注釈

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

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

注意

wingdi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetTextFace を定義します。エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	wingdi.h (Windows.h を含む)
Library	Gdi32.lib
[DLL]	Gdi32.dll