Edit

Share via

IDWriteTextLayout1::GetCharacterSpacing method (dwrite_1.h)

Gets the spacing between characters.

Syntax

HRESULT GetCharacterSpacing(
                  UINT32            currentPosition,
  [out]           FLOAT             *leadingSpacing,
  [out]           FLOAT             *trailingSpacing,
  [out]           FLOAT             *minimumAdvanceWidth,
  [out, optional] DWRITE_TEXT_RANGE *textRange
);

Parameters

currentPosition

Type: UINT32

The current text position.

[out] leadingSpacing

Type: FLOAT*

The spacing before each character, in reading order.

[out] trailingSpacing

Type: FLOAT*

The spacing after each character, in reading order.

[out] minimumAdvanceWidth

Type: FLOAT*

The minimum advance of each character, to prevent characters from becoming too thin or zero-width. This must be zero or greater.

[out, optional] textRange

Type: DWRITE_TEXT_RANGE*

The position range of the current format.

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 and Platform Update for Windows 7 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | UWP apps]
Target Platform Windows
Header dwrite_1.h
Library Dwrite.lib
DLL Dwrite.dll

See also

IDWriteTextLayout1