C API: Locale ID functionality similar to C++ class Locale. More...

#include "unicode/utypes.h"
#include "unicode/uenum.h"

Macros
#define	ULOC_CHINESE "zh"
	Useful constant for this language. More...

#define	ULOC_ENGLISH "en"
	Useful constant for this language. More...

#define	ULOC_FRENCH "fr"
	Useful constant for this language. More...

#define	ULOC_GERMAN "de"
	Useful constant for this language. More...

#define	ULOC_ITALIAN "it"
	Useful constant for this language. More...

#define	ULOC_JAPANESE "ja"
	Useful constant for this language. More...

#define	ULOC_KOREAN "ko"
	Useful constant for this language. More...

#define	ULOC_SIMPLIFIED_CHINESE "zh_CN"
	Useful constant for this language. More...

#define	ULOC_TRADITIONAL_CHINESE "zh_TW"
	Useful constant for this language. More...

#define	ULOC_CANADA "en_CA"
	Useful constant for this country/region. More...

#define	ULOC_CANADA_FRENCH "fr_CA"
	Useful constant for this country/region. More...

#define	ULOC_CHINA "zh_CN"
	Useful constant for this country/region. More...

#define	ULOC_PRC "zh_CN"
	Useful constant for this country/region. More...

#define	ULOC_FRANCE "fr_FR"
	Useful constant for this country/region. More...

#define	ULOC_GERMANY "de_DE"
	Useful constant for this country/region. More...

#define	ULOC_ITALY "it_IT"
	Useful constant for this country/region. More...

#define	ULOC_JAPAN "ja_JP"
	Useful constant for this country/region. More...

#define	ULOC_KOREA "ko_KR"
	Useful constant for this country/region. More...

#define	ULOC_TAIWAN "zh_TW"
	Useful constant for this country/region. More...

#define	ULOC_UK "en_GB"
	Useful constant for this country/region. More...

#define	ULOC_US "en_US"
	Useful constant for this country/region. More...

#define	ULOC_LANG_CAPACITY 12
	Useful constant for the maximum size of the language part of a locale ID. More...

#define	ULOC_COUNTRY_CAPACITY 4
	Useful constant for the maximum size of the country part of a locale ID (including the terminating NULL). More...

#define	ULOC_FULLNAME_CAPACITY 157
	Useful constant for the maximum size of the whole locale ID (including the terminating NULL and all keywords). More...

#define	ULOC_SCRIPT_CAPACITY 6
	Useful constant for the maximum size of the script part of a locale ID (including the terminating NULL). More...

#define	ULOC_KEYWORDS_CAPACITY 96
	Useful constant for the maximum size of keywords in a locale. More...

#define	ULOC_KEYWORD_AND_VALUES_CAPACITY 100
	Useful constant for the maximum total size of keywords and their values in a locale. More...

#define	ULOC_KEYWORD_SEPARATOR '@'
	Invariant character separating keywords from the locale string. More...

#define	ULOC_KEYWORD_SEPARATOR_UNICODE 0x40
	Unicode code point for '@' separating keywords from the locale string. More...

#define	ULOC_KEYWORD_ASSIGN '='
	Invariant character for assigning value to a keyword. More...

#define	ULOC_KEYWORD_ASSIGN_UNICODE 0x3D
	Unicode code point for '=' for assigning value to a keyword. More...

#define	ULOC_KEYWORD_ITEM_SEPARATOR ';'
	Invariant character separating keywords. More...

#define	ULOC_KEYWORD_ITEM_SEPARATOR_UNICODE 0x3B
	Unicode code point for ';' separating keywords. More...

Typedefs
typedef enum ULocAvailableType	ULocAvailableType
	Types for uloc_getAvailableByType and uloc_countAvailableByType. More...

Enumerations
enum	ULocDataLocaleType { ULOC_ACTUAL_LOCALE = 0 , ULOC_VALID_LOCALE = 1 , ULOC_REQUESTED_LOCALE = 2 , ULOC_DATA_LOCALE_TYPE_LIMIT = 3 }
	Constants for *_getLocale() Allow user to select whether she wants information on requested, valid or actual locale. More...

enum	ULocAvailableType { ULOC_AVAILABLE_DEFAULT , ULOC_AVAILABLE_ONLY_LEGACY_ALIASES , ULOC_AVAILABLE_WITH_LEGACY_ALIASES , ULOC_AVAILABLE_COUNT }
	Types for uloc_getAvailableByType and uloc_countAvailableByType. More...

enum	ULayoutType { ULOC_LAYOUT_LTR = 0 , ULOC_LAYOUT_RTL = 1 , ULOC_LAYOUT_TTB = 2 , ULOC_LAYOUT_BTT = 3 , ULOC_LAYOUT_UNKNOWN }
	enums for the return value for the character and line orientation functions. More...

enum	UAcceptResult { ULOC_ACCEPT_FAILED = 0 , ULOC_ACCEPT_VALID = 1 , ULOC_ACCEPT_FALLBACK = 2 }
	Output values which uloc_acceptLanguage() writes to the 'outResult' parameter. More...

Functions
U_CAPI const char *	uloc_getDefault (void)
	Gets ICU's default locale. More...

U_CAPI void	uloc_setDefault (const char localeID, UErrorCode status)
	Sets ICU's default locale. More...

U_CAPI int32_t	uloc_getLanguage (const char localeID, char language, int32_t languageCapacity, UErrorCode *err)
	Gets the language code for the specified locale. More...

U_CAPI int32_t	uloc_getScript (const char localeID, char script, int32_t scriptCapacity, UErrorCode *err)
	Gets the script code for the specified locale. More...

U_CAPI int32_t	uloc_getCountry (const char localeID, char country, int32_t countryCapacity, UErrorCode *err)
	Gets the country code for the specified locale. More...

U_CAPI int32_t	uloc_getVariant (const char localeID, char variant, int32_t variantCapacity, UErrorCode *err)
	Gets the variant code for the specified locale. More...

U_CAPI int32_t	uloc_getName (const char localeID, char name, int32_t nameCapacity, UErrorCode *err)
	Gets the full name for the specified locale. More...

U_CAPI int32_t	uloc_canonicalize (const char localeID, char name, int32_t nameCapacity, UErrorCode *err)
	Gets the full name for the specified locale. More...

U_CAPI const char *	uloc_getISO3Language (const char *localeID)
	Gets the ISO language code for the specified locale. More...

U_CAPI const char *	uloc_getISO3Country (const char *localeID)
	Gets the ISO country code for the specified locale. More...

U_CAPI uint32_t	uloc_getLCID (const char *localeID)
	Gets the Win32 LCID value for the specified locale. More...

U_CAPI int32_t	uloc_getDisplayLanguage (const char locale, const char displayLocale, UChar language, int32_t languageCapacity, UErrorCode status)
	Gets the language name suitable for display for the specified locale. More...

U_CAPI int32_t	uloc_getDisplayScript (const char locale, const char displayLocale, UChar script, int32_t scriptCapacity, UErrorCode status)
	Gets the script name suitable for display for the specified locale. More...

U_CAPI int32_t	uloc_getDisplayCountry (const char locale, const char displayLocale, UChar country, int32_t countryCapacity, UErrorCode status)
	Gets the country name suitable for display for the specified locale. More...

U_CAPI int32_t	uloc_getDisplayVariant (const char locale, const char displayLocale, UChar variant, int32_t variantCapacity, UErrorCode status)
	Gets the variant name suitable for display for the specified locale. More...

U_CAPI int32_t	uloc_getDisplayKeyword (const char keyword, const char displayLocale, UChar dest, int32_t destCapacity, UErrorCode status)
	Gets the keyword name suitable for display for the specified locale. More...

U_CAPI int32_t	uloc_getDisplayKeywordValue (const char locale, const char keyword, const char displayLocale, UChar dest, int32_t destCapacity, UErrorCode *status)
	Gets the value of the keyword suitable for display for the specified locale. More...

U_CAPI int32_t	uloc_getDisplayName (const char localeID, const char inLocaleID, UChar result, int32_t maxResultSize, UErrorCode err)
	Gets the full name suitable for display for the specified locale. More...

U_CAPI const char *	uloc_getAvailable (int32_t n)
	Gets the specified locale from a list of available locales. More...

U_CAPI int32_t	uloc_countAvailable (void)
	Gets the size of the all available locale list. More...

U_CAPI UEnumeration *	uloc_openAvailableByType (ULocAvailableType type, UErrorCode *status)
	Gets a list of available locales according to the type argument, allowing the user to access different sets of supported locales in ICU. More...

U_CAPI const char const	uloc_getISOLanguages (void)
	Gets a list of all available 2-letter language codes defined in ISO 639, plus additional 3-letter codes determined to be useful for locale generation as defined by Unicode CLDR. More...

U_CAPI const char const	uloc_getISOCountries (void)
	Gets a list of all available 2-letter country codes defined in ISO 639. More...

U_CAPI int32_t	uloc_getParent (const char localeID, char parent, int32_t parentCapacity, UErrorCode *err)
	Truncate the locale ID string to get the parent locale ID. More...

U_CAPI int32_t	uloc_getBaseName (const char localeID, char name, int32_t nameCapacity, UErrorCode *err)
	Gets the full name for the specified locale, like uloc_getName(), but without keywords. More...

U_CAPI UEnumeration *	uloc_openKeywords (const char localeID, UErrorCode status)
	Gets an enumeration of keywords for the specified locale. More...

U_CAPI int32_t	uloc_getKeywordValue (const char localeID, const char keywordName, char buffer, int32_t bufferCapacity, UErrorCode status)
	Get the value for a keyword. More...

U_CAPI int32_t	uloc_setKeywordValue (const char keywordName, const char keywordValue, char buffer, int32_t bufferCapacity, UErrorCode status)
	Sets or removes the value of the specified keyword. More...

U_CAPI UBool	uloc_isRightToLeft (const char *locale)
	Returns whether the locale's script is written right-to-left. More...

U_CAPI ULayoutType	uloc_getCharacterOrientation (const char localeId, UErrorCode status)
	Get the layout character orientation for the specified locale. More...

U_CAPI ULayoutType	uloc_getLineOrientation (const char localeId, UErrorCode status)
	Get the layout line orientation for the specified locale. More...

U_CAPI int32_t	uloc_acceptLanguageFromHTTP (char result, int32_t resultAvailable, UAcceptResult outResult, const char httpAcceptLanguage, UEnumeration availableLocales, UErrorCode *status)
	Based on a HTTP header from a web browser and a list of available locales, determine an acceptable locale for the user. More...

U_CAPI int32_t	uloc_acceptLanguage (char result, int32_t resultAvailable, UAcceptResult outResult, const char *acceptList, int32_t acceptListCount, UEnumeration availableLocales, UErrorCode *status)
	Based on a list of available locales, determine an acceptable locale for the user. More...

U_CAPI int32_t	uloc_getLocaleForLCID (uint32_t hostID, char locale, int32_t localeCapacity, UErrorCode status)
	Gets the ICU locale ID for the specified Win32 LCID value. More...

U_CAPI int32_t	uloc_addLikelySubtags (const char localeID, char maximizedLocaleID, int32_t maximizedLocaleIDCapacity, UErrorCode *err)
	Add the likely subtags for a provided locale ID, per the algorithm described in the following CLDR technical report: More...

U_CAPI int32_t	uloc_minimizeSubtags (const char localeID, char minimizedLocaleID, int32_t minimizedLocaleIDCapacity, UErrorCode *err)
	Minimize the subtags for a provided locale ID, per the algorithm described in the following CLDR technical report: More...

U_CAPI int32_t	uloc_forLanguageTag (const char langtag, char localeID, int32_t localeIDCapacity, int32_t parsedLength, UErrorCode err)
	Returns a locale ID for the specified BCP47 language tag string. More...

U_CAPI int32_t	uloc_toLanguageTag (const char localeID, char langtag, int32_t langtagCapacity, UBool strict, UErrorCode *err)
	Returns a well-formed language tag for this locale ID. More...

U_CAPI const char *	uloc_toUnicodeLocaleKey (const char *keyword)
	Converts the specified keyword (legacy key, or BCP 47 Unicode locale extension key) to the equivalent BCP 47 Unicode locale extension key. More...

U_CAPI const char *	uloc_toUnicodeLocaleType (const char keyword, const char value)
	Converts the specified keyword value (legacy type, or BCP 47 Unicode locale extension type) to the well-formed BCP 47 Unicode locale extension type for the specified keyword (category). More...

U_CAPI const char *	uloc_toLegacyKey (const char *keyword)
	Converts the specified keyword (BCP 47 Unicode locale extension key, or legacy key) to the legacy key. More...

U_CAPI const char *	uloc_toLegacyType (const char keyword, const char value)
	Converts the specified keyword value (BCP 47 Unicode locale extension type, or legacy type or type alias) to the canonical legacy type. More...

Detailed Description

C API: Locale ID functionality similar to C++ class Locale.

ULoc C API for Locale

A Locale represents a specific geographical, political, or cultural region. An operation that requires a Locale to perform its task is called locale-sensitive and uses the Locale to tailor information for the user. For example, displaying a number is a locale-sensitive operation–the number should be formatted according to the customs/conventions of the user's native country, region, or culture. In the C APIs, a locales is simply a const char string.

You create a Locale with one of the three options listed below. Each of the component is separated by '_' in the locale string.

newLanguage
 
newLanguage + newCountry
 
newLanguage + newCountry + newVariant

The first option is a valid ISO Language Code. These codes are the lower-case two-letter codes as defined by ISO-639. You can find a full list of these codes at a number of sites, such as:
http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt

The second option includes an additional ISO Country Code. These codes are the upper-case two-letter codes as defined by ISO-3166. You can find a full list of these codes at a number of sites, such as:
http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html

The third option requires another additional information–the Variant. The Variant codes are vendor and browser-specific. For example, use WIN for Windows, MAC for Macintosh, and POSIX for POSIX. Where there are two variants, separate them with an underscore, and put the most important one first. For example, a Traditional Spanish collation might be referenced, with "ES", "ES", "Traditional_WIN".

Because a Locale is just an identifier for a region, no validity check is performed when you specify a Locale. If you want to see whether particular resources are available for the Locale you asked for, you must query those resources. For example, ask the UNumberFormat for the locales it supports using its getAvailable method.
Note: When you ask for a resource for a particular locale, you get back the best available match, not necessarily precisely what you asked for. For more information, look at UResourceBundle.

The Locale provides a number of convenient constants that you can use to specify the commonly used locales. For example, the following refers to a locale for the United States:

ULOC_US
ULOC_US
#define ULOC_US
Useful constant for this country/region.
Definition: uloc.h:244

Once you've specified a locale you can query it for information about itself. Use uloc_getCountry to get the ISO Country Code and uloc_getLanguage to get the ISO Language Code. You can use uloc_getDisplayCountry to get the name of the country suitable for displaying to the user. Similarly, you can use uloc_getDisplayLanguage to get the name of the language suitable for displaying to the user. Interestingly, the uloc_getDisplayXXX methods are themselves locale-sensitive and have two versions: one that uses the default locale and one that takes a locale as an argument and displays the name or country in a language appropriate to that locale.

The ICU provides a number of services that perform locale-sensitive operations. For example, the unum_xxx functions format numbers, currency, or percentages in a locale-sensitive manner.

UErrorCode success = U_ZERO_ERROR;
UNumberFormat *nf;
const char* myLocale = "fr_FR";
 
nf = unum_open( UNUM_DEFAULT, NULL, success );          
unum_close(nf);
nf = unum_open( UNUM_CURRENCY, NULL, success );
unum_close(nf);
nf = unum_open( UNUM_PERCENT, NULL, success );   
unum_close(nf);
unum_open
U_CAPI UNumberFormat * unum_open(UNumberFormatStyle style, const UChar *pattern, int32_t patternLength, const char *locale, UParseError *parseErr, UErrorCode *status)
Create and return a new UNumberFormat for formatting and parsing numbers.
UNUM_CURRENCY
@ UNUM_CURRENCY
Currency format (generic).
Definition: unum.h:169
UNUM_PERCENT
@ UNUM_PERCENT
Percent format.
Definition: unum.h:174
UNUM_DEFAULT
@ UNUM_DEFAULT
Default format.
Definition: unum.h:267
UNumberFormat
void * UNumberFormat
A number formatter.
Definition: unum.h:145
unum_close
U_CAPI void unum_close(UNumberFormat *fmt)
Close a UNumberFormat.
NULL
#define NULL
Define NULL if necessary, to nullptr for C++ and to ((void *)0) for C.
Definition: utypes.h:203
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:509
U_ZERO_ERROR
@ U_ZERO_ERROR
No error, no warning.
Definition: utypes.h:544

Each of these methods has two variants; one with an explicit locale and one without; the latter using the default locale.

nf = unum_open( UNUM_DEFAULT, myLocale, success );          
unum_close(nf);
nf = unum_open( UNUM_CURRENCY, myLocale, success );
unum_close(nf);
nf = unum_open( UNUM_PERCENT, myLocale, success );   
unum_close(nf);

A Locale is the mechanism for identifying the kind of services (UNumberFormat) that you would like to get. The locale is just a mechanism for identifying these services.

Each international service that performs locale-sensitive operations allows you to get all the available objects of that type. You can sift through these objects by language, country, or variant, and use the display names to present a menu to the user. For example, you can create a menu of all the collation objects suitable for a given language. Such classes implement these three class methods:

const char* uloc_getAvailable(int32_t index);
int32_t uloc_countAvailable();
int32_t
uloc_getDisplayName(const char* localeID,
          const char* inLocaleID, 
          UChar* result,
          int32_t maxResultSize,
           UErrorCode* err);
uloc_getAvailable
U_CAPI const char * uloc_getAvailable(int32_t n)
Gets the specified locale from a list of available locales.
uloc_getDisplayName
U_CAPI int32_t uloc_getDisplayName(const char *localeID, const char *inLocaleID, UChar *result, int32_t maxResultSize, UErrorCode *err)
Gets the full name suitable for display for the specified locale.
uloc_countAvailable
U_CAPI int32_t uloc_countAvailable(void)
Gets the size of the all available locale list.
UChar
char16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:400

Concerning POSIX/RFC1766 Locale IDs, the getLanguage/getCountry/getVariant/getName functions do understand the POSIX type form of language_COUNTRY.ENCODING@VARIANT and if there is not an ICU-stype variant, uloc_getVariant() for example will return the one listed after the @at sign. As well, the hyphen "-" is recognized as a country/variant separator similarly to RFC1766. So for example, "en-us" will be interpreted as en_US.
As a result, uloc_getName() is far from a no-op, and will have the effect of converting POSIX/RFC1766 IDs into ICU form, although it does NOT map any of the actual codes (i.e. russian->ru) in any way. Applications should call uloc_getName() at the point where a locale ID is coming from an external source (user entry, OS, web browser) and pass the resulting string to other ICU functions. For example, don't use de-de@EURO as an argument to resourcebundle.

See also: UResourceBundle

Definition in file uloc.h.

Macro Definition Documentation

◆ ULOC_CANADA

#define ULOC_CANADA "en_CA"

Useful constant for this country/region.

Stable:: ICU 2.0

Definition at line 222 of file uloc.h.

◆ ULOC_CANADA_FRENCH

#define ULOC_CANADA_FRENCH "fr_CA"

Useful constant for this country/region.

Stable:: ICU 2.0

Definition at line 224 of file uloc.h.

◆ ULOC_CHINA

#define ULOC_CHINA "zh_CN"

Useful constant for this country/region.

Stable:: ICU 2.0

Definition at line 226 of file uloc.h.

◆ ULOC_CHINESE

#define ULOC_CHINESE "zh"

Useful constant for this language.

Stable:: ICU 2.0

Definition at line 203 of file uloc.h.

◆ ULOC_COUNTRY_CAPACITY

#define ULOC_COUNTRY_CAPACITY 4

Useful constant for the maximum size of the country part of a locale ID (including the terminating NULL).

Stable:: ICU 2.0

Definition at line 258 of file uloc.h.

◆ ULOC_ENGLISH

#define ULOC_ENGLISH "en"

Useful constant for this language.

Stable:: ICU 2.0

Definition at line 205 of file uloc.h.

◆ ULOC_FRANCE

#define ULOC_FRANCE "fr_FR"

Useful constant for this country/region.

Stable:: ICU 2.0

Definition at line 230 of file uloc.h.

◆ ULOC_FRENCH

#define ULOC_FRENCH "fr"

Useful constant for this language.

Stable:: ICU 2.0

Definition at line 207 of file uloc.h.

◆ ULOC_FULLNAME_CAPACITY

#define ULOC_FULLNAME_CAPACITY 157

Useful constant for the maximum size of the whole locale ID (including the terminating NULL and all keywords).

Stable:: ICU 2.0

Definition at line 264 of file uloc.h.

◆ ULOC_GERMAN

#define ULOC_GERMAN "de"

Useful constant for this language.

Stable:: ICU 2.0

Definition at line 209 of file uloc.h.

◆ ULOC_GERMANY

#define ULOC_GERMANY "de_DE"

Useful constant for this country/region.

Stable:: ICU 2.0

Definition at line 232 of file uloc.h.

◆ ULOC_ITALIAN

#define ULOC_ITALIAN "it"

Useful constant for this language.

Stable:: ICU 2.0

Definition at line 211 of file uloc.h.

◆ ULOC_ITALY

#define ULOC_ITALY "it_IT"

Useful constant for this country/region.

Stable:: ICU 2.0

Definition at line 234 of file uloc.h.

◆ ULOC_JAPAN

#define ULOC_JAPAN "ja_JP"

Useful constant for this country/region.

Stable:: ICU 2.0

Definition at line 236 of file uloc.h.

◆ ULOC_JAPANESE

#define ULOC_JAPANESE "ja"

Useful constant for this language.

Stable:: ICU 2.0

Definition at line 213 of file uloc.h.

◆ ULOC_KEYWORD_AND_VALUES_CAPACITY

#define ULOC_KEYWORD_AND_VALUES_CAPACITY 100

Useful constant for the maximum total size of keywords and their values in a locale.

Stable:: ICU 2.8

Definition at line 283 of file uloc.h.

◆ ULOC_KEYWORD_ASSIGN

#define ULOC_KEYWORD_ASSIGN '='

Invariant character for assigning value to a keyword.

Stable:: ICU 2.8

Definition at line 302 of file uloc.h.

◆ ULOC_KEYWORD_ASSIGN_UNICODE

#define ULOC_KEYWORD_ASSIGN_UNICODE 0x3D

Unicode code point for '=' for assigning value to a keyword.

See also: ULOC_KEYWORD_ASSIGN

Stable:: ICU 4.6

Definition at line 309 of file uloc.h.

◆ ULOC_KEYWORD_ITEM_SEPARATOR

#define ULOC_KEYWORD_ITEM_SEPARATOR ';'

Invariant character separating keywords.

Stable:: ICU 2.8

Definition at line 315 of file uloc.h.

◆ ULOC_KEYWORD_ITEM_SEPARATOR_UNICODE

#define ULOC_KEYWORD_ITEM_SEPARATOR_UNICODE 0x3B

Unicode code point for ';' separating keywords.

See also: ULOC_KEYWORD_ITEM_SEPARATOR

Stable:: ICU 4.6

Definition at line 322 of file uloc.h.

◆ ULOC_KEYWORD_SEPARATOR

#define ULOC_KEYWORD_SEPARATOR '@'

Invariant character separating keywords from the locale string.

Stable:: ICU 2.8

Definition at line 289 of file uloc.h.

◆ ULOC_KEYWORD_SEPARATOR_UNICODE

#define ULOC_KEYWORD_SEPARATOR_UNICODE 0x40

Unicode code point for '@' separating keywords from the locale string.

See also: ULOC_KEYWORD_SEPARATOR

Stable:: ICU 4.6

Definition at line 296 of file uloc.h.

◆ ULOC_KEYWORDS_CAPACITY

#define ULOC_KEYWORDS_CAPACITY 96

Useful constant for the maximum size of keywords in a locale.

Stable:: ICU 2.8

Definition at line 277 of file uloc.h.

◆ ULOC_KOREA

#define ULOC_KOREA "ko_KR"

Useful constant for this country/region.

Stable:: ICU 2.0

Definition at line 238 of file uloc.h.

◆ ULOC_KOREAN

#define ULOC_KOREAN "ko"

Useful constant for this language.

Stable:: ICU 2.0

Definition at line 215 of file uloc.h.

◆ ULOC_LANG_CAPACITY

#define ULOC_LANG_CAPACITY 12

Useful constant for the maximum size of the language part of a locale ID.

(including the terminating NULL).

Stable:: ICU 2.0

Definition at line 251 of file uloc.h.

◆ ULOC_PRC

#define ULOC_PRC "zh_CN"

Useful constant for this country/region.

Stable:: ICU 2.0

Definition at line 228 of file uloc.h.

◆ ULOC_SCRIPT_CAPACITY

#define ULOC_SCRIPT_CAPACITY 6

Useful constant for the maximum size of the script part of a locale ID (including the terminating NULL).

Stable:: ICU 2.8

Definition at line 271 of file uloc.h.

◆ ULOC_SIMPLIFIED_CHINESE

#define ULOC_SIMPLIFIED_CHINESE "zh_CN"

Useful constant for this language.

Stable:: ICU 2.0

Definition at line 217 of file uloc.h.

◆ ULOC_TAIWAN

#define ULOC_TAIWAN "zh_TW"

Useful constant for this country/region.

Stable:: ICU 2.0

Definition at line 240 of file uloc.h.

◆ ULOC_TRADITIONAL_CHINESE

#define ULOC_TRADITIONAL_CHINESE "zh_TW"

Useful constant for this language.

Stable:: ICU 2.0

Definition at line 219 of file uloc.h.

◆ ULOC_UK

#define ULOC_UK "en_GB"

Useful constant for this country/region.

Stable:: ICU 2.0

Definition at line 242 of file uloc.h.

◆ ULOC_US

#define ULOC_US "en_US"

Useful constant for this country/region.

Stable:: ICU 2.0

Definition at line 244 of file uloc.h.

Typedef Documentation

◆ ULocAvailableType

typedef enum ULocAvailableType ULocAvailableType

Types for uloc_getAvailableByType and uloc_countAvailableByType.

Stable:: ICU 65

Enumeration Type Documentation

◆ UAcceptResult

enum UAcceptResult

Output values which uloc_acceptLanguage() writes to the 'outResult' parameter.

See also: uloc_acceptLanguageFromHTTP; uloc_acceptLanguage

Stable:: ICU 3.2

Enumerator

ULOC_ACCEPT_FAILED

No exact match was found.

Stable:: ICU 3.2

ULOC_ACCEPT_VALID

An exact match was found.

Stable:: ICU 3.2

ULOC_ACCEPT_FALLBACK

A fallback was found.

For example, the Accept-Language list includes 'ja_JP' and is matched with available locale 'ja'.

Stable:: ICU 3.2

Definition at line 1083 of file uloc.h.

◆ ULayoutType

enum ULayoutType

enums for the return value for the character and line orientation functions.

Stable:: ICU 4.0

Definition at line 1044 of file uloc.h.

◆ ULocAvailableType

enum ULocAvailableType

Types for uloc_getAvailableByType and uloc_countAvailableByType.

Stable:: ICU 65

Enumerator

ULOC_AVAILABLE_DEFAULT

Locales that return data when passed to ICU APIs, but not including legacy or alias locales.

Stable:: ICU 65

ULOC_AVAILABLE_ONLY_LEGACY_ALIASES

Legacy or alias locales that return data when passed to ICU APIs.

Examples of supported legacy or alias locales:

iw (alias to he)
mo (alias to ro)
zh_CN (alias to zh_Hans_CN)
sr_BA (alias to sr_Cyrl_BA)
ars (alias to ar_SA)

The locales in this set are disjoint from the ones in ULOC_AVAILABLE_DEFAULT. To get both sets at the same time, use ULOC_AVAILABLE_WITH_LEGACY_ALIASES.

Stable:: ICU 65

Macros

Typedefs

Enumerations

Functions

Detailed Description

ULoc C API for Locale

Macro Definition Documentation

◆ ULOC_CANADA

◆ ULOC_CANADA_FRENCH

◆ ULOC_CHINA

◆ ULOC_CHINESE

◆ ULOC_COUNTRY_CAPACITY

◆ ULOC_ENGLISH

◆ ULOC_FRANCE

◆ ULOC_FRENCH

◆ ULOC_FULLNAME_CAPACITY

◆ ULOC_GERMAN

◆ ULOC_GERMANY

◆ ULOC_ITALIAN

◆ ULOC_ITALY

◆ ULOC_JAPAN

◆ ULOC_JAPANESE

◆ ULOC_KEYWORD_AND_VALUES_CAPACITY

◆ ULOC_KEYWORD_ASSIGN

◆ ULOC_KEYWORD_ASSIGN_UNICODE

◆ ULOC_KEYWORD_ITEM_SEPARATOR

◆ ULOC_KEYWORD_ITEM_SEPARATOR_UNICODE

◆ ULOC_KEYWORD_SEPARATOR

◆ ULOC_KEYWORD_SEPARATOR_UNICODE

◆ ULOC_KEYWORDS_CAPACITY

◆ ULOC_KOREA

◆ ULOC_KOREAN

◆ ULOC_LANG_CAPACITY

◆ ULOC_PRC

◆ ULOC_SCRIPT_CAPACITY

◆ ULOC_SIMPLIFIED_CHINESE

◆ ULOC_TAIWAN

◆ ULOC_TRADITIONAL_CHINESE

◆ ULOC_UK

◆ ULOC_US

Typedef Documentation

◆ ULocAvailableType

Enumeration Type Documentation

◆ UAcceptResult

◆ ULayoutType

◆ ULocAvailableType