IDWriteTextLayout::GetLineMetrics メソッド

テキスト文字列の各テキスト行に関する情報を取得します。

構文

virtual HRESULT GetLineMetrics(
  [out, optional]  DWRITE_LINE_METRICS * lineMetrics,
                   UINT32  maxLineCount,
  [out]            UINT32 * actualLineCount
) = 0;

パラメーター

  • lineMetrics [out, optional]
    このメソッドが返されるときに、各テキスト行の計算されたさまざまな長さの値を含む構造体の配列へのポインターが格納されます。

  • maxLineCount
    lineMetrics 配列の最大サイズ。

  • actualLineCount [out]
    このメソッドが返されるときに、必要な lineMetrics 配列の実際のサイズが格納されます。

戻り値

メソッドが成功した場合は、S_OK が返されます。 それ以外の場合は、エラー コードが返されます。HRESULT.

解説

maxLineCount の大きさが不十分な場合は、HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) に相当する E_NOT_SUFFICIENT_BUFFER が返され、*actualLineCount が必要な行数に設定されます。

要件

クライアントの最小要件

Windows 7, Windows Vista SP2 および Windows Vista 用のプラットフォーム更新プログラム

サーバーの最小要件

Windows Server 2008 R2, Windows Server 2008 SP2 および Windows Server 2008 用のプラットフォーム更新プログラム

ヘッダー

Dwrite.h

ライブラリ

Dwrite.lib

DLL

Dwrite.dll

参照

IDWriteTextLayout