IDWriteTextFormat::GetLineSpacing method (dwrite.h)

Gets the line spacing adjustment set for a multiline text paragraph.

Syntax

HRESULT GetLineSpacing(
  [out] DWRITE_LINE_SPACING_METHOD *lineSpacingMethod,
  [out] FLOAT                      *lineSpacing,
  [out] FLOAT                      *baseline
);

Parameters

[out] lineSpacingMethod

Type: DWRITE_LINE_SPACING_METHOD*

A value that indicates how line height is determined.

[out] lineSpacing

Type: FLOAT*

When this method returns, contains the line height, or distance between one baseline to another.

[out] baseline

Type: FLOAT*

When this method returns, contains the distance from top of line to baseline. A reasonable ratio to lineSpacing is 80 percent.

Return value

Type: HRESULT

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

Requirements

See also

IDWriteTextFormat