IDWriteTextLayout::GetFontStretch method (dwrite.h)

Gets the font stretch of the text at the specified position.

Syntax

HRESULT GetFontStretch(
                  UINT32              currentPosition,
  [out]           DWRITE_FONT_STRETCH *fontStretch,
  [out, optional] DWRITE_TEXT_RANGE   *textRange
);

Parameters

currentPosition

Type: UINT32

The position of the text to inspect.

[out] fontStretch

Type: DWRITE_FONT_STRETCH*

When this method returns, contains a value which indicates the type of font stretch (also known as width) being applied at the specified position.

[out, optional] textRange

Type: DWRITE_TEXT_RANGE*

The range of text that has the same formatting as the text at the position specified by currentPosition. This means the run has the exact formatting as the position specified, including but not limited to the font stretch.

Return value

Type: HRESULT

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

Requirements

See also

IDWriteTextLayout