IDWriteTextLayout::GetLocaleName method (dwrite.h)

Gets the locale name of the text at the specified position.

Syntax

HRESULT GetLocaleName(
                  UINT32            currentPosition,
  [out]           WCHAR             *localeName,
                  UINT32            nameSize,
  [out, optional] DWRITE_TEXT_RANGE *textRange
);

Parameters

currentPosition

Type: UINT32

The position of the text to inspect.

[out] localeName

Type: WCHAR*

When this method returns, contains the character array receiving the current locale name.

nameSize

Type: UINT32

Size of the character array, in character count, including the terminated NULL character.

[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 locale name.

Return value

Type: HRESULT

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

Requirements

See also

IDWriteTextLayout