IDWriteTextLayout::GetLineMetrics メソッド (dwrite.h)

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

構文

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

パラメーター

[out, optional] lineMetrics

種類: DWRITE_LINE_METRICS*

このメソッドが戻るときに、 には、個々のテキスト行のさまざまな計算長値を含む構造体の配列へのポインターが含まれます。

maxLineCount

型: UINT32

lineMetrics 配列の最大サイズ。

[out] actualLineCount

種類: UINT32*

このメソッドから制御が戻るときに、必要な lineMetrics 配列の実際のサイズが格納されます。

戻り値

型: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

解説

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

要件

関連項目

IDWriteTextLayout