IDWriteTextLayout::GetUnderline method (dwrite.h)

Gets the underline presence of the text at the specified position.

Syntax

HRESULT GetUnderline(
                  UINT32            currentPosition,
  [out]           BOOL              *hasUnderline,
  [out, optional] DWRITE_TEXT_RANGE *textRange
);

Parameters

currentPosition

Type: UINT32

The current text position.

[out] hasUnderline

Type: BOOL*

A Boolean flag that indicates whether underline is present at the position indicated by currentPosition.

[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 underline.

Return value

Type: HRESULT

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

Requirements

See also

IDWriteTextLayout