Edit

IDWriteLocalizedStrings::GetLocaleName method (dwrite.h)

  • Article

Copies the locale name with the specified index to the specified array.

Syntax

HRESULT GetLocaleName(
        UINT32 index,
  [out] WCHAR  *localeName,
        UINT32 size
);

Parameters

index

Type: UINT32

Zero-based index of the locale name to be retrieved.

[out] localeName

Type: WCHAR*

When this method returns, contains a character array, which is null-terminated, that receives the locale name from the language/string pair. The buffer allocated for this array must be at least the size of size, in element count.

size

Type: UINT32

The size of the array in characters. The size must include space for the terminating null character.

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

See also

IDWriteLocalizedStrings