IDWriteTextLayout2::GetMetrics method (dwrite_2.h)

Retrieves overall metrics for the formatted string.

Syntax

HRESULT GetMetrics(
  [out] DWRITE_TEXT_METRICS1 *textMetrics
);

Parameters

[out] textMetrics

Type: DWRITE_TEXT_METRICS1*

When this method returns, contains the measured distances of text and associated content after being formatted.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows 8.1 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 R2 [desktop apps | UWP apps]
Target Platform Windows
Header dwrite_2.h
Library Dwrite.lib
DLL Dwrite.dll

See also

IDWriteTextLayout2