NLS: Name-based APIs Sample
The sample application described in this topic demonstrates some of the NLS "locale name" functions. Your applications should use locale names instead of locale identifiers when possible.
The sample application uses EnumSystemLocalesEx to enumerate all locales on the operating system, including supplemental locales.
The enumeration callback function supported by the application can take one or more locale names as parameters. EnumSystemLocalesEx passes these names to the callback function in the optional lparam value. If the user enters the locales on the command line, the callback function only displays the specified locales instead of displaying all locales.
For each displayed locale, the callback function reports whether it is the system locale, prints the current date using the default formats of the locale, and displays all data for the locale in each locale information constant introduced in Windows Vista, for example, LOCALE_SSCRIPTS.
The sample application parses any input locales to see if they are valid by using IsValidLocaleName.
This sample demonstrates the following functions:
- CompareStringEx
- EnumSystemLocalesEx
- GetDateFormatEx
- GetLocaleInfoEx
- GetSystemDefaultLocaleName
- IsValidLocaleName
- LocaleNameToLCID
// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF // ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A // PARTICULAR PURPOSE. // // Copyright (c) Microsoft Corporation. All rights reserved. // // ======================================================================== // CONSOLE APPLICATION : NamedNlsFunctions Project Overview #include "stdafx.h" #include "windows.h" #include "stdio.h" // All of the LCTYPES new to Windows Vista LCTYPE NewTypes[] = { LOCALE_SNAME, LOCALE_SDURATION, LOCALE_SKEYBOARDSTOINSTALL, LOCALE_SSHORTESTDAYNAME1, LOCALE_SSHORTESTDAYNAME2, LOCALE_SSHORTESTDAYNAME3, LOCALE_SSHORTESTDAYNAME4, LOCALE_SSHORTESTDAYNAME5, LOCALE_SSHORTESTDAYNAME6, LOCALE_SSHORTESTDAYNAME7, LOCALE_SISO639LANGNAME2, LOCALE_SISO3166CTRYNAME2, LOCALE_SNAN, LOCALE_SPOSINFINITY, LOCALE_SNEGINFINITY, LOCALE_SSCRIPTS }; // Strings so we can print out the LCTYPES LPCWSTR NewTypeNames[] = { L"LOCALE_SNAME", L"LOCALE_SDURATION", L"LOCALE_SKEYBOARDSTOINSTALL", L"LOCALE_SSHORTESTDAYNAME1", L"LOCALE_SSHORTESTDAYNAME2", L"LOCALE_SSHORTESTDAYNAME3", L"LOCALE_SSHORTESTDAYNAME4", L"LOCALE_SSHORTESTDAYNAME5", L"LOCALE_SSHORTESTDAYNAME6", L"LOCALE_SSHORTESTDAYNAME7", L"LOCALE_SISO639LANGNAME2", L"LOCALE_SISO3166CTRYNAME2", L"LOCALE_SNAN", L"LOCALE_SPOSINFINITY", L"LOCALE_SNEGINFINITY", L"LOCALE_SSCRIPTS" }; // Callback for EnumSystemLocalesEx() #define BUFFER_SIZE 512 BOOL CALLBACK MyFuncLocaleEx(LPWSTR pStr, DWORD dwFlags, LPARAM lparam) { UNREFERENCED_PARAMETER(dwFlags); WCHAR** argv = (WCHAR**)lparam; WCHAR wcBuffer[BUFFER_SIZE]; int iResult; int i; // If specific locales were specified on the command line check for a match if (*argv && argv[1]) { // Check each argument to see if our locale matches for (i = 1; argv[i] != 0; i++) { // Using invariant, check if the name matches the input. CompareStringEx // is probably overkill, but we want to demonstrate that named API. if (CompareStringEx(LOCALE_NAME_INVARIANT, LINGUISTIC_IGNORECASE, argv[i], -1, pStr, -1, NULL, NULL, 0) == CSTR_EQUAL) { break; } } // If no match then stop and don't output this one if (argv[i] == 0) return TRUE; } // Print out the locale name we found iResult = GetLocaleInfoEx(pStr, LOCALE_SENGLANGUAGE, wcBuffer, BUFFER_SIZE); // If it succeeds, print it out if (iResult > 0) wprintf(L"Locale %s (%s)\n", pStr, wcBuffer); else wprintf(L"Locale %s had error %d\n", pStr, GetLastError()); // If this is the system locale, let us know. CompareStringEx // is probably overkill, but we want to demonstrate that named API. iResult = GetSystemDefaultLocaleName(wcBuffer, BUFFER_SIZE); if (iResult > 0) { if (CompareStringEx(LOCALE_NAME_INVARIANT, LINGUISTIC_IGNORECASE, wcBuffer, -1, pStr, -1, NULL, NULL, 0) == CSTR_EQUAL) { wprintf(L"Locale %s is the system locale!\n", wcBuffer); } } else { wprintf(L"Error %d getting system locale\n", GetLastError()); } // Get its LCID LCID lcid = LocaleNameToLCID(pStr, NULL); if (lcid != 0) wprintf(L"LCID for %s is %x\n", pStr, lcid); else wprintf(L"Error %d getting LCID\n", GetLastError()); // Get today's date iResult = GetDateFormatEx(pStr, DATE_LONGDATE, NULL, NULL, wcBuffer, BUFFER_SIZE, NULL); if (iResult > 0) wprintf(L"Date: %s\n", wcBuffer); else wprintf(L"Error %d getting today's date for %s\n", GetLastError(), pStr); // Loop through all of the new LCTYPES and do GetLocaleInfoEx on them for (i = 0; i < sizeof(NewTypes) / sizeof(NewTypes[0]); i++) { // Get this LCTYPE result for this locale iResult = GetLocaleInfoEx(pStr, NewTypes[i], wcBuffer, BUFFER_SIZE); // If it succeeds, print it out if (iResult > 0) { wprintf(L" %s has value %s\n", NewTypeNames[i], wcBuffer); } else { wprintf(L" %s had error %d\n", NewTypeNames[i], GetLastError()); } } return (TRUE); } int __cdecl wmain(int argc, wchar_t* argv[]) { UNREFERENCED_PARAMETER(argc); // Enumerate all the locales and report on them EnumSystemLocalesEx( MyFuncLocaleEx, LOCALE_ALL, (LPARAM)argv, NULL); // See which of the input locales are valid (if any) if (*argv && argv[1]) { // Check each argument to see if our locale matches for (int i = 1; argv[i] != 0; i++) { // See if this is a valid locale name if (!IsValidLocaleName(argv[i])) { wprintf(L"%s is not a valid locale name\n", argv[i]); } } } } /* The following is a portion of the results produced by this code example. Locale en-US (English) Locale en-US is the system locale! LCID for en-US is 409 Date: Wednesday, February 03, 2010 LOCALE_SNAME has value en-US LOCALE_SDURATION has value h:mm:ss LOCALE_SKEYBOARDSTOINSTALL has value 0409:00000409 LOCALE_SSHORTESTDAYNAME1 has value Mo LOCALE_SSHORTESTDAYNAME2 has value Tu LOCALE_SSHORTESTDAYNAME3 has value We LOCALE_SSHORTESTDAYNAME4 has value Th LOCALE_SSHORTESTDAYNAME5 has value Fr LOCALE_SSHORTESTDAYNAME6 has value Sa LOCALE_SSHORTESTDAYNAME7 has value Su LOCALE_SISO639LANGNAME2 has value eng LOCALE_SISO3166CTRYNAME2 has value USA LOCALE_SNAN has value NaN LOCALE_SPOSINFINITY has value Infinity LOCALE_SNEGINFINITY has value -Infinity LOCALE_SSCRIPTS has value Latn; Locale fr-FR (French) LCID for fr-FR is 40c Date: mercredi 3 f�vrier 2010 LOCALE_SNAME has value fr-FR LOCALE_SDURATION has value HH:mm:ss LOCALE_SKEYBOARDSTOINSTALL has value 040c:0000040c;0409:00000409 LOCALE_SSHORTESTDAYNAME1 has value lu LOCALE_SSHORTESTDAYNAME2 has value ma LOCALE_SSHORTESTDAYNAME3 has value me LOCALE_SSHORTESTDAYNAME4 has value je LOCALE_SSHORTESTDAYNAME5 has value ve LOCALE_SSHORTESTDAYNAME6 has value sa LOCALE_SSHORTESTDAYNAME7 has value di LOCALE_SISO639LANGNAME2 has value fra LOCALE_SISO3166CTRYNAME2 has value FRA LOCALE_SNAN has value Non Num�rique LOCALE_SPOSINFINITY has value +Infini LOCALE_SNEGINFINITY has value -Infini LOCALE_SSCRIPTS has value Latn; Locale es-ES (Spanish) LCID for es-ES is c0a Date: mi�rcoles, 03 de febrero de 2010 LOCALE_SNAME has value es-ES LOCALE_SDURATION has value H:mm:ss LOCALE_SKEYBOARDSTOINSTALL has value 0c0a:0000040a;0409:00000409 LOCALE_SSHORTESTDAYNAME1 has value lu LOCALE_SSHORTESTDAYNAME2 has value ma LOCALE_SSHORTESTDAYNAME3 has value mi LOCALE_SSHORTESTDAYNAME4 has value ju LOCALE_SSHORTESTDAYNAME5 has value vi LOCALE_SSHORTESTDAYNAME6 has value s� LOCALE_SSHORTESTDAYNAME7 has value do LOCALE_SISO639LANGNAME2 has value spa LOCALE_SISO3166CTRYNAME2 has value ESP LOCALE_SNAN has value NeuN LOCALE_SPOSINFINITY has value Infinito LOCALE_SNEGINFINITY has value -Infinito LOCALE_SSCRIPTS has value Latn; */