National/Regional Language Support (NLS) Functions (Compact 2013)

3/28/2014

The following table describes the National/Regional Language Support (NLS) functions in Windows Embedded Compact 2013.

The NLS API supports the LCID and locale names listed in National/Regional Language Support (NLS) Catalog Items and Sysgen Variables. In previous versions of Windows Embedded Compact, a Sysgen variable was required to implement the NLS API. In Windows Embedded Compact 2013, this API is always available.

In This Section

• CompareString
  Compares two Unicode strings, using the locale that an identifier specifies.

• CompareStringEx
  Compares two Unicode strings, using the locale that a name specifies.

• CompareStringOrdinal
  Compares two Unicode strings for binary equivalence.

• ConvertDefaultLocale
  Converts a special default locale value to an actual locale identifier.

• EnumCalendarInfo
  Enumerates calendar information by calling an application-defined callback function.

• EnumCalendarInfoEx
  Enumerates calendar information for a locale that an identifier specifies.

• EnumCalendarInfoExEx
  Enumerates calendar information for a locale that a name specifies.

• EnumCalendarInfoProc
  Application-defined callback function that processes enumerated calendar information that the EnumCalendarInfo function provides.

• EnumCalendarInfoProcEx
  Application-defined callback function that processes enumerated calendar information that the EnumCalendarInfoEx function provides.

• EnumCalendarInfoProcExEx
  Application-defined callback function that processes enumerated calendar information that the EnumCalendarInfoExEx function provides.

• EnumCodePagesProc
  Application-defined callback function that processes enumerated code-page information that the EnumSystemCodePages function provides.

• EnumDateFormats
  Enumerates the long or short date formats available for a specified locale, including date formats for any alternate calendars.

• EnumDateFormatsEx
  Enumerates the long date, short date, or year/month formats available for a specified locale.

• EnumDateFormatsExEx
  Enumerates the long date, short date, or year/month formats available for a locale specified by name.

• EnumDateFormatsProc
  Application-defined callback function. It is called because of a call to the EnumDateFormats function, and receives a pointer to a string buffer that contains a date format string.

• EnumDateFormatsProcEx
  Application-defined callback function that processes date format information that the EnumDateFormatsEx function provides.

• EnumDateFormatsProcExEx
  Application-defined callback function that processes date format information that the EnumDateFormatsExEx function provides.

• EnumLocalesProc
  Application-defined callback function, called in response to a call to the EnumSystemLocale function. It receives a pointer to a string buffer that contains a locale identifier.

• EnumLocalesProcEx
  Application-defined callback function, called in response to a call to the EnumSystemLocaleEx function. It receives a pointer to a string buffer that contains a locale identifier.

• EnumSystemCodePages
  Enumerates the code pages that are either installed on or supported by a system.

• EnumSystemLocales
  Enumerates the locales that are either installed on or supported by a system.

• EnumSystemLocalesEx
  Enumerates the locales that are either installed on or supported by an OS.

• EnumTimeFormats
  Enumerates the time formats available for a locale that an identifier specifies.

• EnumTimeFormatsEx
  Enumerates time formats available for a locale that a name specifies.

• EnumTimeFormatsProc
  Application-defined callback function that processes enumerated time-format information that EnumTimeFormats provides.

• EnumTimeFormatsProcEx
  Application-defined callback function that processes enumerated time-format information that EnumTimeFormatsEx provides.

• FindStringOrdinal
  Locates a Unicode string (a string composed of wide characters) in another Unicode string for a non-linguistic comparison.

• FoldString
  Maps one string to another, performing a specified transformation option.

• GetACP
  Retrieves the current ANSI code-page identifier for the system.

• GetCalendarInfo
  Retrieves information about a calendar for a locale that an identifier specifies.

• GetCalendarInfoEx
  Retrieves information about a calendar for a locale that a name specifies.

• GetCPInfo
  Retrieves information about any valid installed or available code page.

• GetCurrencyFormat
  Formats a number string as a currency string for a locale that an identifier specifies.

• GetCurrencyFormatEx
  Formats a number string as a currency string for a locale that a name specifies.

• GetDateFormat
  Formats a time duration as a time string for a locale that an identifier specifies.

• GetDateFormatEx
  Formats a time duration as a time string for a locale that a name specifies.

• GetDurationFormat
  Formats a date as a date string for a specified locale.

• GetDurationFormatEx
  Formats a time duration as a time string for a locale that a name specifies.

• GetLocaleInfo
  Retrieves information about a locale that an identifier specifies. Retrieves locale data that is in Unicode format.

• GetLocaleInfoEx
  Retrieves information about a locale that a name specifies.

• GetNumberFormat
  Formats a number string as a number string that is customized for a locale that an identifier specifies.

• GetNumberFormatEx
  Formats a number string as a number string that is customized for a locale that a name specifies.

• GetOEMCP
  Retrieves the current OEM code-page identifier for the system.

• GetStringScripts
  Returns a list of scripts used in the specified Unicode string.

• GetStringTypeEx
  Returns character-type information for the specified Unicode source string.

• GetStringTypeW
  Returns character-type information for the characters in the specified UNICODE source string.

• GetSystemDefaultLangID
  Retrieves the system default language identifier.

• GetSystemDefaultLCID
  Retrieves the system default locale identifier.

• GetSystemDefaultLocaleName
  Retrieves the system default locale name.

• GetTimeFormat
  Formats a time as a time string for a locale that an identifier specifies.

• GetTimeFormatEx
  Formats a time as a time string for a locale that a name specifies.

• GetUserDefaultLangID
  Retrieves the user-default language identifier.

• GetUserDefaultLCID
  Retrieves the locale identifier for the user default locale.

• GetUserDefaultLocaleName
  Retrieves the user-default locale name.

• IdnToAscii
  Converts an internationalized domain name (IDN) or other internationalized label to Unicode (wide) representation of the ASCII string that represents the name in the Punycode transfer encoding.

• IdnToNameprepUnicode
  Converts an IDN or other internationalized label to the NamePrep form that Network Working Group RFC 3491 specifies, but does not perform the additional conversion to Punycode.

• IdnToUnicode
  Converts the Punycode form of an IDN or another internationalized label to the normal Unicode UTF-16 encoding syntax.

• IsNLSDefinedString
  Determines whether each character in a string has a defined result for a specified NLS capability.

• IsNormalizedString
  Determines whether a language group is installed or supported on the OS.

• IsValidCodePage
  Determines whether a specified code page is valid.

• IsValidLocale
  Applies a validity test to a locale identifier.

• IsValidLocaleName
  Determines whether the specified locale name is valid for a locale that is installed on or supported by the OS.

• LCIDToLocaleName
  Converts a locale identifier to a locale name.

• LCMapString
  Maps one character string to another, performing a specified locale-dependent transformation.

• LCMapStringEx
  For a locale specified by name, maps one input character string to another using a specified transformation, or generates a sort key for the input string.

• LocaleNameToLCID
  Converts a locale name to a locale identifier.

• NormalizeString
  Normalizes characters of a text string according to Unicode 4.0 Technical Report #15, a specification for four normalized forms of Unicode text.

• ResolveLocaleName
  Finds a possible locale name match for the supplied name.

• SetACP
  Sets the current ANSI code-page identifier for the OS.

• SetCalendarInfo
  Sets an item of locale information for a calendar.

• SetLocaleInfo
  Sets an item of locale information.

• SetOEMCP
  Sets the current OEM code-page identifier for the OS.

• SetSystemDefaultLCID
  Sets the system default locale identifier.

• SetUserDefaultLCID
  Sets the locale identifier for the current user's locale selection.

• UpdateCalendarDayOfWeek
  Returns the day of week that corresponds to a specified day, and populates the DayOfWeek field in the given CALDATETIME structure.

• VerifyScripts
  Compares two enumerated lists of scripts.

The following functions are no longer supported and should not be used.

• AdjustCalendarDate
  Adjusts a date by a specified number of years, months, weeks, or days.

• BytesToUnicode
  Converts GB18030 bytes to Unicode characters. Use MultiByteToWideChar instead of this unsupported function.

• ConvertCalDateTimeToSystemTime
  Converts a specified CALDATETIME structure to a SYSTEMTIME structure.

• ConvertSystemTimetoCalDateTime
  Converts a specified SYSTEMTIME structure to a CALDATETIME structure.

• EnumGeoInfoProc
  Application-defined callback function that processes enumerated geographical location information that the EnumSystemGeoID function provides.

• EnumLanguageGroupLocales
  Enumerates the locales in a specified language group.

• EnumLanguageGroupLocalesProc
  Application-defined callback function that processes enumerated language group locale information that the EnumLanguageGroupLocales function provides.

• EnumLanguageGroupsProc
  Application-defined callback function that processes enumerated language group information that the EnumSystemLanguageGroups function provides.

• EnumSystemGeoID
  Enumerates the unique identification numbers for a geographical country/region, city, or location (type GEOID) that is available on the operating system.

• EnumSystemLanguageGroups
  Enumerates the language groups that are either installed on or supported by an OS.

• FindNLSString
  Locates a Unicode (wide) string or its equivalent in another Unicode string for a locale that an identifier specifies.

• FindNLSStringEx
  Locates a Unicode (wide) string or its equivalent in another Unicode string for a locale that a name specifies.

• GetCalendarDateFormatEx
  Retrieves a properly formatted date string for the specified locale using the specified date.

• GetCalendarSupportedDateRange
  Retrieves the supported date range for a specified calendar.

• GetCPInfoEx
  Retrieves information about any valid installed or available code page.

• GetGeoInfo
  Retrieves information about a specified geographical location.

• GetStringType
  Returns character-type information for the characters in the specified source string.

• GetStringTypeA
  Retrieves character-type information for the characters in the specified ANSI source string.

• GetStringTypeW
  Retrieves character-type information for the characters in the specified Unicode source string.

• GetUserGeoID
  Retrieves information about the geographical country/region, city, or location of a device.

• IsCalendarLeapYear
  Identifies whether the specified year is a leap year within the given era for the specific calendar.

• IsValidLanguageGroup
  Determines if a language group is installed or supported on the operating system.

• NlsDllCodePageTranslation
  Retrieves code page information or converts characters, depending on the flags you set.

• SetUserGeoID
  Sets the unique identification number for a geographical country/region, city, or location for the device.

• UnicodeToBytes
  Converts Unicode characters to GB18030 bytes. Use WideCharToMultiByte instead of this unsupported function.

See Also

Reference

National/Regional Language Support (NLS) Reference