ICU 74.2: common/unicode/ulocale.h Source File

ICU 74.2 74.2

ulocale.h
Go to the documentation of this file.
1// © 2023 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3
4#ifndef ULOCALE_H
5#define ULOCALE_H
6
7#include "unicode/localpointer.h"
8#include "unicode/uenum.h"
9#include "unicode/utypes.h"
10
16#ifndef U_HIDE_DRAFT_API
21struct ULocale;
22
27 typedef struct ULocale ULocale;
28
42 U_CAPI ULocale* U_EXPORT2
43ulocale_openForLocaleID(const char* localeID, int32_t length, UErrorCode* err);
44
58 U_CAPI ULocale* U_EXPORT2
59ulocale_openForLanguageTag(const char* tag, int32_t length, UErrorCode* err);
60
67 U_CAPI void U_EXPORT2
68ulocale_close(ULocale* locale);
69
77 U_CAPI const char* U_EXPORT2
78ulocale_getLanguage(const ULocale* locale);
79
87 U_CAPI const char* U_EXPORT2
88ulocale_getScript(const ULocale* locale);
89
97 U_CAPI const char* U_EXPORT2
98ulocale_getRegion(const ULocale* locale);
99
107 U_CAPI const char* U_EXPORT2
108ulocale_getVariant(const ULocale* locale);
109
120 U_CAPI const char* U_EXPORT2
121ulocale_getLocaleID(const ULocale* locale);
122
131 U_CAPI const char* U_EXPORT2
132ulocale_getBaseName(const ULocale* locale);
133
141 U_CAPI bool U_EXPORT2
142ulocale_isBogus(const ULocale* locale);
143
153 U_CAPI UEnumeration* U_EXPORT2
154ulocale_getKeywords(const ULocale* locale, UErrorCode *err);
155
165 U_CAPI UEnumeration* U_EXPORT2
166ulocale_getUnicodeKeywords(const ULocale* locale, UErrorCode *err);
167
183 U_CAPI int32_t U_EXPORT2
184ulocale_getKeywordValue(
185 const ULocale* locale, const char* keyword, int32_t keywordLength,
186 char* valueBuffer, int32_t valueBufferCapacity, UErrorCode *err);
187
203 U_CAPI int32_t U_EXPORT2
204ulocale_getUnicodeKeywordValue(
205 const ULocale* locale, const char* keyword, int32_t keywordLength,
206 char* valueBuffer, int32_t valueBufferCapacity, UErrorCode *err);
207
208#if U_SHOW_CPLUSPLUS_API
209
210U_NAMESPACE_BEGIN
211
221 U_DEFINE_LOCAL_OPEN_POINTER(LocalULocalePointer, ULocale, ulocale_close);
222
223U_NAMESPACE_END
224
225#endif /* U_SHOW_CPLUSPLUS_API */
226
227#endif /* U_HIDE_DRAFT_API */
228
229#endif /*_ULOCALE */
LocalULocalePointer
"Smart pointer" class, closes a ULocale via ulocale_close().
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
U_DEFINE_LOCAL_OPEN_POINTER
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition localpointer.h:550
uenum.h
C API: String Enumeration.
UEnumeration
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition uenum.h:44
ulocale_getVariant
U_CAPI const char * ulocale_getVariant(const ULocale *locale)
Returns the locale's variant code.
ulocale_getBaseName
U_CAPI const char * ulocale_getBaseName(const ULocale *locale)
Returns the programmatic name of the entire locale as ulocale_getLocaleID() would return,...
ulocale_getKeywords
U_CAPI UEnumeration * ulocale_getKeywords(const ULocale *locale, UErrorCode *err)
Gets the list of keywords for the specified locale.
ulocale_getUnicodeKeywords
U_CAPI UEnumeration * ulocale_getUnicodeKeywords(const ULocale *locale, UErrorCode *err)
Gets the list of unicode keywords for the specified locale.
ulocale_getRegion
U_CAPI const char * ulocale_getRegion(const ULocale *locale)
Returns the locale's ISO-3166 region code.
ulocale_getScript
U_CAPI const char * ulocale_getScript(const ULocale *locale)
Returns the locale's ISO-15924 abbreviation script code.
ULocale
struct ULocale ULocale
C typedef for struct ULocale.
Definition ulocale.h:27
ulocale_openForLocaleID
U_CAPI ULocale * ulocale_openForLocaleID(const char *localeID, int32_t length, UErrorCode *err)
Constructs an ULocale from the locale ID.
ulocale_getUnicodeKeywordValue
U_CAPI int32_t ulocale_getUnicodeKeywordValue(const ULocale *locale, const char *keyword, int32_t keywordLength, char *valueBuffer, int32_t valueBufferCapacity, UErrorCode *err)
Gets the Unicode value for a Unicode keyword.
ulocale_openForLanguageTag
U_CAPI ULocale * ulocale_openForLanguageTag(const char *tag, int32_t length, UErrorCode *err)
Constructs an ULocale from the provided IETF BCP 47 language tag.
ulocale_isBogus
U_CAPI bool ulocale_isBogus(const ULocale *locale)
Gets the bogus state.
ulocale_getLocaleID
U_CAPI const char * ulocale_getLocaleID(const ULocale *locale)
Returns the programmatic name of the entire locale, with the language, country and variant separated ...
ulocale_getLanguage
U_CAPI const char * ulocale_getLanguage(const ULocale *locale)
Returns the locale's ISO-639 language code.
ulocale_close
U_CAPI void ulocale_close(ULocale *locale)
Close the locale and destroy it's internal states.
ulocale_getKeywordValue
U_CAPI int32_t ulocale_getKeywordValue(const ULocale *locale, const char *keyword, int32_t keywordLength, char *valueBuffer, int32_t valueBufferCapacity, UErrorCode *err)
Gets the value for a keyword.
U_CAPI
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition umachine.h:110
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition utypes.h:415