GetTextExtentPointW

GetTextExtentPoint 関数は、指定したテキスト文字列の幅と高さを計算する。(Unicode)

GetTextExtentPointW hdc, lpString, c, lpsz

hdc : [intptr] デバイスコンテキストのハンドル。
lpString : [wstr] テキストを指定する文字列へのポインタ。cbString が文字列の長さを指定するため、0 終端である必要はない。
c : [int] lpString が指す文字列の長さ。
lpsz : [var] 文字列の寸法(論理単位)を受け取る SIZE 構造体へのポインタ。

(プラグイン / モジュール : gdi32.dll)

解説

GetTextExtentPoint 関数は、指定したテキスト文字列の幅と高さを計算する。(Unicode)

[戻り値]
関数が成功した場合、戻り値は 0 以外である。失敗した場合は 0 である。

[備考]
GetTextExtentPoint
関数は、現在選択されているフォントを使って文字列の寸法を計算する。幅と高さ(論理単位)はクリッピングを考慮せずに計算される。また、この関数はテキストが水平である(つまり
escapement が常に 0)と想定する。これはテキストの水平と垂直の両方の測定に当てはまる。0 以外の escapement
を指定するフォントを使用していても、この関数はテキストの長さを計算する際に角度を使わない。アプリケーションが明示的に変換する必要がある。一部のデバイスは文字間をカーニングするため、文字列内の各文字の長さの合計は文字列全体の長さと等しくならない場合がある。計算される文字列幅は
SetTextCharacterExtra 関数で設定された文字間隔を考慮する。
> [!NOTE] > wingdi.h ヘッダは GetTextExtentPoint をエイリアスとして定義しており、UNICODE
プリプロセッサ定数の有無に応じてこの関数の ANSI 版または Unicode
版が自動的に選択される。エンコーディング中立なエイリアスと非中立コードを混在させると、コンパイルまたは実行時エラーの原因となる不整合を引き起こすことがある。詳細は
[関数プロトタイプの規則](/windows/win32/intl/conventions-for-function-prototypes)
を参照。

情報