Defines | |||
![]() | ![]() | #define | ULOC_ENGLISH |
![]() | ![]() | A Locale represents a specific geographical, political, or cultural region. More... | |
![]() | ![]() | #define | ULOC_FRENCH |
![]() | ![]() | #define | ULOC_GERMAN |
![]() | ![]() | #define | ULOC_ITALIAN |
![]() | ![]() | #define | ULOC_JAPANESE |
![]() | ![]() | #define | ULOC_KOREAN |
![]() | ![]() | #define | ULOC_CHINESE |
![]() | ![]() | #define | ULOC_SIMPLIFIED_CHINESE |
![]() | ![]() | #define | ULOC_TRADITIONAL_CHINESE |
![]() | ![]() | #define | ULOC_FRANCE |
![]() | ![]() | #define | ULOC_GERMANY |
![]() | ![]() | #define | ULOC_ITALY |
![]() | ![]() | #define | ULOC_JAPAN |
![]() | ![]() | #define | ULOC_KOREA |
![]() | ![]() | #define | ULOC_CHINA |
![]() | ![]() | #define | ULOC_PRC |
![]() | ![]() | #define | ULOC_TAIWAN |
![]() | ![]() | #define | ULOC_UK |
![]() | ![]() | #define | ULOC_US |
![]() | ![]() | #define | ULOC_CANADA |
![]() | ![]() | #define | ULOC_CANADA_FRENCH |
![]() | ![]() | #define | uloc_getDataDirectory |
![]() | ![]() | Deprecated 1999dec14 - Gets the directory containing the locale data files. More... | |
![]() | ![]() | #define | uloc_setDataDirectory |
![]() | ![]() | Deprecated 1999dec14 - Sets the directory containing the locale data files. More... | |
Functions | |||
![]() | ![]() | U_CAPI const char* U_EXPORT2 | uloc_getDefault (void) |
![]() | ![]() | Gets the system's default locale. More... | |
![]() | ![]() | U_CAPI void U_EXPORT2 | uloc_setDefault (const char* localeID, UErrorCode* status) |
![]() | ![]() | Sets the system's default locale. More... | |
![]() | ![]() | U_CAPI int32_t U_EXPORT2 | 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 U_EXPORT2 | 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 U_EXPORT2 | 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 U_EXPORT2 | uloc_getName (const char* localeID, char* name, int32_t nameCapacity, UErrorCode* err) |
![]() | ![]() | Gets the full name for the specified locale. More... | |
![]() | ![]() | U_CAPI const char* U_EXPORT2 | uloc_getISO3Language (const char* localeID) |
![]() | ![]() | Gets the ISO language code for the specified locale. More... | |
![]() | ![]() | U_CAPI const char* U_EXPORT2 | uloc_getISO3Country (const char* localeID) |
![]() | ![]() | Gets the ISO country code for the specified locale. More... | |
![]() | ![]() | U_CAPI uint32_t U_EXPORT2 | uloc_getLCID (const char* localeID) |
![]() | ![]() | Gets the Win32 LCID value for the specified locale. More... | |
![]() | ![]() | U_CAPI int32_t U_EXPORT2 | uloc_getDisplayLanguage (const char* locale, const char* inLocale, UChar* language, int32_t languageCapacity, UErrorCode* status) |
![]() | ![]() | Gets the language name suitable for display for the specified locale. More... | |
![]() | ![]() | U_CAPI int32_t U_EXPORT2 | uloc_getDisplayCountry (const char* locale, const char* inLocale, UChar* country, int32_t countryCapacity, UErrorCode* status) |
![]() | ![]() | Gets the country name suitable for display for the specified locale. More... | |
![]() | ![]() | U_CAPI int32_t U_EXPORT2 | uloc_getDisplayVariant (const char* locale, const char* inLocale, UChar* variant, int32_t variantCapacity, UErrorCode* status) |
![]() | ![]() | Gets the variant code suitable for display for the specified locale. More... | |
![]() | ![]() | U_CAPI int32_t U_EXPORT2 | 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* U_EXPORT2 | uloc_getAvailable (int32_t n) |
![]() | ![]() | Gets the specified locale from a list of all available locales. More... | |
![]() | ![]() | U_CAPI int32_t U_EXPORT2 | uloc_countAvailable (void) |
![]() | ![]() | Gets the size of the all available locale list. More... | |
![]() | ![]() | U_CAPI const char* const* U_EXPORT2 | uloc_getISOLanguages (void) |
![]() | ![]() | Gets a list of all available language codes defined in ISO 639. More... | |
![]() | ![]() | U_CAPI const char* const* U_EXPORT2 | uloc_getISOCountries (void) |
![]() | ![]() | Gets a list of all available 2-letter country codes defined in ISO 639. More... | |
![]() | ![]() | int32_t U_EXPORT2 | uloc_getParent (const char* localeID, char* parent, int32_t parentCapacity, UErrorCode* err) |
#define ULOC_ENGLISH () |
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.
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:. newLanguage . . newLanguage + newCountry . . newLanguage + newCountry + newVariant
http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt
The second option includes an additonal 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 additonal 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
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.
Each of these methods has two variants; one with an explicit locale and one without; the latter using the default locale.. 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);
A. . 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);
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 serivce 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); .
#define ULOC_FRENCH () |
#define ULOC_GERMAN () |
#define ULOC_ITALIAN () |
#define ULOC_JAPANESE () |
#define ULOC_KOREAN () |
#define ULOC_CHINESE () |
#define ULOC_SIMPLIFIED_CHINESE () |
#define ULOC_TRADITIONAL_CHINESE () |
#define ULOC_FRANCE () |
#define ULOC_GERMANY () |
#define ULOC_ITALY () |
#define ULOC_JAPAN () |
#define ULOC_KOREA () |
#define ULOC_CHINA () |
#define ULOC_PRC () |
#define ULOC_TAIWAN () |
#define ULOC_UK () |
#define ULOC_US () |
#define ULOC_CANADA () |
#define ULOC_CANADA_FRENCH () |
#define uloc_getDataDirectory () |
Deprecated 1999dec14 - Gets the directory containing the locale data files.
#define uloc_setDataDirectory () |
Deprecated 1999dec14 - Sets the directory containing the locale data files.
U_CAPI const char *U_EXPORT2 uloc_getDefault (void) |
Gets the system's default locale.
This pointer may become invalid if the uloc_setDefault() is called.
U_CAPI void U_EXPORT2 uloc_setDefault (const char * localeID, UErrorCode * status) |
Sets the system's default locale.
Call this once during setup or program initialization. This is a system API.
localeID | the new system default locale |
status | the error information if the setting of default locale fails |
U_CAPI int32_t U_EXPORT2 uloc_getLanguage (const char * localeID, char * language, int32_t languageCapacity, UErrorCode * err) |
Gets the language code for the specified locale.
localeID | the locale to get the ISO langauge code with |
language | the langauge code for localeID |
languageCapacity | the size of the language buffer to store the language code with |
err | error information if retrieving the language code failed |
U_CAPI int32_t U_EXPORT2 uloc_getCountry (const char * localeID, char * country, int32_t countryCapacity, UErrorCode * err) |
Gets the country code for the specified locale.
localeID | the locale to get the country code with |
country | the country code for localeID |
languageCapacity | the size of the coutry buffer to store the country code with |
err | error information if retrieving the country code failed |
U_CAPI int32_t U_EXPORT2 uloc_getVariant (const char * localeID, char * variant, int32_t variantCapacity, UErrorCode * err) |
Gets the variant code for the specified locale.
localeID | the locale to get the variant code with |
variant | the variant code for localeID |
variantCapacity | the size of the variant buffer to store the variant code with |
err | error information if retrieving the variant code failed |
U_CAPI int32_t U_EXPORT2 uloc_getName (const char * localeID, char * name, int32_t nameCapacity, UErrorCode * err) |
Gets the full name for the specified locale.
localeID | the locale to get the full name with |
name | the full name for localeID |
nameCapacity | the size of the name buffer to store the full name with |
err | error information if retrieving the full name failed |
U_CAPI const char *U_EXPORT2 uloc_getISO3Language (const char * localeID) |
Gets the ISO language code for the specified locale.
localeID | the locale to get the ISO langauge code with |
U_CAPI const char *U_EXPORT2 uloc_getISO3Country (const char * localeID) |
Gets the ISO country code for the specified locale.
localeID | the locale to get the ISO country code with |
U_CAPI uint32_t U_EXPORT2 uloc_getLCID (const char * localeID) |
Gets the Win32 LCID value for the specified locale.
localeID | the locale to get the Win32 LCID value with |
U_CAPI int32_t U_EXPORT2 uloc_getDisplayLanguage (const char * locale, const char * inLocale, UChar * language, int32_t languageCapacity, UErrorCode * status) |
Gets the language name suitable for display for the specified locale.
localeID | the locale to get the ISO langauge code with |
language | the displayable langauge code for localeID |
languageCapacity | the size of the language buffer to store the displayable language code with |
err | error information if retrieving the displayable language code failed |
U_CAPI int32_t U_EXPORT2 uloc_getDisplayCountry (const char * locale, const char * inLocale, UChar * country, int32_t countryCapacity, UErrorCode * status) |
Gets the country name suitable for display for the specified locale.
localeID | the locale to get the displayable country code with |
country | the displayable country code for localeID |
languageCapacity | the size of the coutry buffer to store the displayable country code with |
err | error information if retrieving the displayable country code failed |
U_CAPI int32_t U_EXPORT2 uloc_getDisplayVariant (const char * locale, const char * inLocale, UChar * variant, int32_t variantCapacity, UErrorCode * status) |
Gets the variant code suitable for display for the specified locale.
localeID | the locale to get the displayable variant code with |
variant | the displayable variant code for localeID |
variantCapacity | the size of the variant buffer to store the displayable variant code with |
err | error information if retrieving the displayable variant code failed |
U_CAPI int32_t U_EXPORT2 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.
localeID | the locale to get the displayable name with |
variant | the displayable name for localeID |
variantCapacity | the size of the name buffer to store the displayable full name with |
err | error information if retrieving the displayable name failed |
U_CAPI const char *U_EXPORT2 uloc_getAvailable (int32_t n) |
Gets the specified locale from a list of all available locales.
The return value is a pointer to an item of a locale name array. Both this array and the pointers it contains are owned by ICU and should not be deleted or written through by the caller. The locale name is terminated by a null pointer.
n | the specific locale name index of the available locale list |
U_CAPI int32_t U_EXPORT2 uloc_countAvailable (void) |
Gets the size of the all available locale list.
U_CAPI const char *const *U_EXPORT2 uloc_getISOLanguages (void) |
Gets a list of all available language codes defined in ISO 639.
This is a pointer to an array of pointers to arrays of char. All of these pointers are owned by ICU-- do not delete them, and do not write through them. The array is terminated with a null pointer.
U_CAPI const char *const *U_EXPORT2 uloc_getISOCountries (void) |
Gets a list of all available 2-letter country codes defined in ISO 639.
This is a pointer to an array of pointers to arrays of char. All of these pointers are owned by ICU-- do not delete them, and do not write through them. The array is terminated with a null pointer.
int32_t U_EXPORT2 uloc_getParent (const char * localeID, char * parent, int32_t parentCapacity, UErrorCode * err) |