The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IDWriteTextAnalysisSource::GetLocaleName method

Gets the locale name on the range affected by the text analysis.

Syntax

C++


virtual HRESULT GetLocaleName(
              UINT32 textPosition,
  [out]       UINT32 *textLength,
  [out] const WCHAR  **localeName
) = 0;

Parameters

textPosition

Type: UINT32

The text position to examine.

textLength [out]

Type: UINT32*

Contains the length of the text being affected by the text analysis up to the next differing locale.

localeName [out]

Type: const WCHAR**

Contains an address of a pointer to an array of characters which receives the locale name from the text affected by the text analysis. The array of characters is null-terminated.

Return value

Type: HRESULT

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

Remarks

The localeName pointer must remain valid until the next call or until the analysis returns.

Requirements

Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| Windows Store apps]
Minimum supported phone	Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]
Header	Dwrite.h
Library	Dwrite.lib
DLL	Dwrite.dll