ICU 72.1 72.1
ucol.h
Go to the documentation of this file.
1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/*
4*******************************************************************************
5* Copyright (c) 1996-2015, International Business Machines Corporation and others.
6* All Rights Reserved.
7*******************************************************************************
8*/
9
10#ifndef UCOL_H
11#define UCOL_H
12
13#include "unicode/utypes.h"
14
15#if !UCONFIG_NO_COLLATION
16
17#include "unicode/unorm.h"
18#include "unicode/parseerr.h"
19#include "unicode/uloc.h"
20#include "unicode/uset.h"
21#include "unicode/uscript.h"
22
23#if U_SHOW_CPLUSPLUS_API
25#endif // U_SHOW_CPLUSPLUS_API
26
57struct UCollator;
61typedef struct UCollator UCollator;
62
63
76typedef enum {
82 UCOL_LESS = -1
84
85
92typedef enum {
95
104 UCOL_CE_STRENGTH_LIMIT,
109 UCOL_STRENGTH_LIMIT,
110
119
124
130
131#ifndef U_HIDE_DEPRECATED_API
137#endif /* U_HIDE_DEPRECATED_API */
139
149 typedef enum {
204#ifndef U_HIDE_DEPRECATED_API
210#endif /* U_HIDE_DEPRECATED_API */
212
240
245typedef enum {
314#ifndef U_HIDE_DEPRECATED_API
327#endif /* U_HIDE_DEPRECATED_API */
347
348 /* Do not conditionalize the following with #ifndef U_HIDE_DEPRECATED_API,
349 * it is needed for layout of RuleBasedCollator object. */
350#ifndef U_FORCE_HIDE_DEPRECATED_API
356#endif // U_FORCE_HIDE_DEPRECATED_API
358
362typedef enum {
378
404U_CAPI UCollator* U_EXPORT2
405ucol_open(const char *loc, UErrorCode *status);
406
432U_CAPI UCollator* U_EXPORT2
433ucol_openRules( const UChar *rules,
434 int32_t rulesLength,
435 UColAttributeValue normalizationMode,
436 UCollationStrength strength,
437 UParseError *parseError,
438 UErrorCode *status);
439
440#ifndef U_HIDE_DEPRECATED_API
474U_DEPRECATED UCollator* U_EXPORT2
475ucol_openFromShortString( const char *definition,
476 UBool forceDefaults,
477 UParseError *parseError,
478 UErrorCode *status);
479#endif /* U_HIDE_DEPRECATED_API */
480
481#ifndef U_HIDE_DEPRECATED_API
495U_DEPRECATED int32_t U_EXPORT2
497 USet *conts,
498 UErrorCode *status);
499#endif /* U_HIDE_DEPRECATED_API */
500
512U_CAPI void U_EXPORT2
514 USet *contractions, USet *expansions,
515 UBool addPrefixes, UErrorCode *status);
516
527U_CAPI void U_EXPORT2
529
530#if U_SHOW_CPLUSPLUS_API
531
532U_NAMESPACE_BEGIN
533
544
545U_NAMESPACE_END
546
547#endif
548
564U_CAPI UCollationResult U_EXPORT2
566 const UChar *source,
567 int32_t sourceLength,
568 const UChar *target,
569 int32_t targetLength);
570
589U_CAPI UCollationResult U_EXPORT2
591 const UCollator *coll,
592 const char *source,
593 int32_t sourceLength,
594 const char *target,
595 int32_t targetLength,
596 UErrorCode *status);
597
612U_CAPI UBool U_EXPORT2
614 const UChar *source, int32_t sourceLength,
615 const UChar *target, int32_t targetLength);
616
631U_CAPI UBool U_EXPORT2
633 const UChar *source, int32_t sourceLength,
634 const UChar *target, int32_t targetLength);
635
650U_CAPI UBool U_EXPORT2
652 const UChar *source, int32_t sourceLength,
653 const UChar *target, int32_t targetLength);
654
667U_CAPI UCollationResult U_EXPORT2
669 UCharIterator *sIter,
670 UCharIterator *tIter,
671 UErrorCode *status);
672
682U_CAPI UCollationStrength U_EXPORT2
684
694U_CAPI void U_EXPORT2
696 UCollationStrength strength);
697
714U_CAPI int32_t U_EXPORT2
716 int32_t* dest,
717 int32_t destCapacity,
718 UErrorCode *pErrorCode);
759U_CAPI void U_EXPORT2
761 const int32_t* reorderCodes,
762 int32_t reorderCodesLength,
763 UErrorCode *pErrorCode);
764
784U_CAPI int32_t U_EXPORT2
786 int32_t* dest,
787 int32_t destCapacity,
788 UErrorCode *pErrorCode);
789
802U_CAPI int32_t U_EXPORT2
803ucol_getDisplayName( const char *objLoc,
804 const char *dispLoc,
805 UChar *result,
806 int32_t resultLength,
807 UErrorCode *status);
808
818U_CAPI const char* U_EXPORT2
819ucol_getAvailable(int32_t localeIndex);
820
829U_CAPI int32_t U_EXPORT2
831
832#if !UCONFIG_NO_SERVICE
841U_CAPI UEnumeration* U_EXPORT2
843#endif
844
854U_CAPI UEnumeration* U_EXPORT2
856
868U_CAPI UEnumeration* U_EXPORT2
869ucol_getKeywordValues(const char *keyword, UErrorCode *status);
870
887U_CAPI UEnumeration* U_EXPORT2
889 const char* locale,
890 UBool commonlyUsed,
891 UErrorCode* status);
892
924U_CAPI int32_t U_EXPORT2
925ucol_getFunctionalEquivalent(char* result, int32_t resultCapacity,
926 const char* keyword, const char* locale,
927 UBool* isAvailable, UErrorCode* status);
928
937U_CAPI const UChar* U_EXPORT2
939 int32_t *length);
940
941#ifndef U_HIDE_DEPRECATED_API
962U_DEPRECATED int32_t U_EXPORT2
964 const char *locale,
965 char *buffer,
966 int32_t capacity,
967 UErrorCode *status);
968
988U_DEPRECATED int32_t U_EXPORT2
990 char *destination,
991 int32_t capacity,
992 UParseError *parseError,
993 UErrorCode *status);
994#endif /* U_HIDE_DEPRECATED_API */
995
996
1019U_CAPI int32_t U_EXPORT2
1021 const UChar *source,
1022 int32_t sourceLength,
1023 uint8_t *result,
1024 int32_t resultLength);
1025
1026
1047U_CAPI int32_t U_EXPORT2
1049 UCharIterator *iter,
1050 uint32_t state[2],
1051 uint8_t *dest, int32_t count,
1052 UErrorCode *status);
1053
1061typedef enum {
1068#ifndef U_HIDE_DEPRECATED_API
1074#endif /* U_HIDE_DEPRECATED_API */
1076
1114U_CAPI int32_t U_EXPORT2
1115ucol_getBound(const uint8_t *source,
1116 int32_t sourceLength,
1117 UColBoundMode boundType,
1118 uint32_t noOfLevels,
1119 uint8_t *result,
1120 int32_t resultLength,
1121 UErrorCode *status);
1122
1131U_CAPI void U_EXPORT2
1133
1141U_CAPI void U_EXPORT2
1143
1191U_CAPI int32_t U_EXPORT2
1192ucol_mergeSortkeys(const uint8_t *src1, int32_t src1Length,
1193 const uint8_t *src2, int32_t src2Length,
1194 uint8_t *dest, int32_t destCapacity);
1195
1207U_CAPI void U_EXPORT2
1209
1221U_CAPI UColAttributeValue U_EXPORT2
1223
1240U_CAPI void U_EXPORT2
1242
1250U_CAPI UColReorderCode U_EXPORT2
1252
1253#ifndef U_HIDE_DEPRECATED_API
1274U_DEPRECATED uint32_t U_EXPORT2
1276 const UChar *varTop, int32_t len,
1277 UErrorCode *status);
1278#endif /* U_HIDE_DEPRECATED_API */
1279
1291U_CAPI uint32_t U_EXPORT2 ucol_getVariableTop(const UCollator *coll, UErrorCode *status);
1292
1293#ifndef U_HIDE_DEPRECATED_API
1308U_DEPRECATED void U_EXPORT2
1309ucol_restoreVariableTop(UCollator *coll, const uint32_t varTop, UErrorCode *status);
1310#endif /* U_HIDE_DEPRECATED_API */
1311
1322U_CAPI UCollator* U_EXPORT2 ucol_clone(const UCollator *coll, UErrorCode *status);
1323
1324#ifndef U_HIDE_DEPRECATED_API
1325
1349U_DEPRECATED UCollator* U_EXPORT2
1351 void *stackBuffer,
1352 int32_t *pBufferSize,
1353 UErrorCode *status);
1354
1355
1359#define U_COL_SAFECLONE_BUFFERSIZE 1
1360
1361#endif /* U_HIDE_DEPRECATED_API */
1362
1378U_CAPI int32_t U_EXPORT2
1379ucol_getRulesEx(const UCollator *coll, UColRuleOption delta, UChar *buffer, int32_t bufferLen);
1380
1381#ifndef U_HIDE_DEPRECATED_API
1396U_DEPRECATED const char * U_EXPORT2
1398#endif /* U_HIDE_DEPRECATED_API */
1399
1414U_CAPI const char * U_EXPORT2
1416
1427U_CAPI USet * U_EXPORT2
1429
1430#ifndef U_HIDE_INTERNAL_API
1442U_CAPI int32_t U_EXPORT2
1444 USet *unsafe,
1445 UErrorCode *status);
1446
1467U_CAPI void U_EXPORT2
1468ucol_prepareShortStringOpen( const char *definition,
1469 UBool forceDefaults,
1470 UParseError *parseError,
1471 UErrorCode *status);
1472#endif /* U_HIDE_INTERNAL_API */
1473
1485U_CAPI int32_t U_EXPORT2
1487 uint8_t *buffer, int32_t capacity,
1488 UErrorCode *status);
1489
1507U_CAPI UCollator* U_EXPORT2
1508ucol_openBinary(const uint8_t *bin, int32_t length,
1509 const UCollator *base,
1510 UErrorCode *status);
1511
1512
1513#endif /* #if !UCONFIG_NO_COLLATION */
1514
1515#endif
"Smart pointer" class, closes a UCollator via ucol_close().
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:550
C API: Parse Error Information.
C API for code unit iteration.
Definition: uiter.h:341
A UParseError struct is used to returned detailed information about parsing errors.
Definition: parseerr.h:58
U_CAPI void ucol_setMaxVariable(UCollator *coll, UColReorderCode group, UErrorCode *pErrorCode)
Sets the variable top to the top of the specified reordering group.
uint32_t ucol_setVariableTop(UCollator *coll, const UChar *varTop, int32_t len, UErrorCode *status)
Sets the variable top to the primary weight of the specified string.
U_CAPI int32_t ucol_getRulesEx(const UCollator *coll, UColRuleOption delta, UChar *buffer, int32_t bufferLen)
Returns current rules.
U_CAPI void ucol_getVersion(const UCollator *coll, UVersionInfo info)
Gets the version information for a Collator.
U_CAPI void ucol_getContractionsAndExpansions(const UCollator *coll, USet *contractions, USet *expansions, UBool addPrefixes, UErrorCode *status)
Get a set containing the expansions defined by the collator.
U_CAPI uint32_t ucol_getVariableTop(const UCollator *coll, UErrorCode *status)
Gets the variable top value of a Collator.
U_CAPI UColAttributeValue ucol_getAttribute(const UCollator *coll, UColAttribute attr, UErrorCode *status)
Universal attribute getter.
U_CAPI const char * ucol_getLocaleByType(const UCollator *coll, ULocDataLocaleType type, UErrorCode *status)
gets the locale name of the collator.
U_CAPI void ucol_setStrength(UCollator *coll, UCollationStrength strength)
Set the collation strength used in a UCollator.
U_CAPI int32_t ucol_getUnsafeSet(const UCollator *coll, USet *unsafe, UErrorCode *status)
Calculates the set of unsafe code points, given a collator.
U_CAPI UCollator * ucol_openBinary(const uint8_t *bin, int32_t length, const UCollator *base, UErrorCode *status)
Opens a collator from a collator binary image created using ucol_cloneBinary.
U_CAPI UCollator * ucol_open(const char *loc, UErrorCode *status)
Open a UCollator for comparing strings.
struct UCollator UCollator
structure representing a collator object instance
Definition: ucol.h:61
U_CAPI void ucol_setAttribute(UCollator *coll, UColAttribute attr, UColAttributeValue value, UErrorCode *status)
Universal attribute setter.
U_CAPI UEnumeration * ucol_openAvailableLocales(UErrorCode *status)
Create a string enumerator of all locales for which a valid collator may be opened.
U_CAPI UColReorderCode ucol_getMaxVariable(const UCollator *coll)
Returns the maximum reordering group whose characters are affected by UCOL_ALTERNATE_HANDLING.
int32_t ucol_normalizeShortDefinitionString(const char *source, char *destination, int32_t capacity, UParseError *parseError, UErrorCode *status)
Verifies and normalizes short definition string.
UColRuleOption
Options for retrieving the rule string.
Definition: ucol.h:362
@ UCOL_FULL_RULES
Retrieves the "UCA rules" concatenated with the tailoring rules.
Definition: ucol.h:376
@ UCOL_TAILORING_ONLY
Retrieves the tailoring rules only.
Definition: ucol.h:368
UColAttribute
Attributes that collation service understands.
Definition: ucol.h:245
@ UCOL_CASE_FIRST
Controls the ordering of upper and lower case letters.
Definition: ucol.h:272
@ UCOL_NUMERIC_COLLATION
When turned on, this attribute makes substrings of digits sort according to their numeric values.
Definition: ucol.h:346
@ UCOL_STRENGTH
The strength attribute.
Definition: ucol.h:313
@ UCOL_CASE_LEVEL
Controls whether an extra case level (positioned before the third level) is generated or not.
Definition: ucol.h:282
@ UCOL_FRENCH_COLLATION
Attribute for direction of secondary weights - used in Canadian French.
Definition: ucol.h:252
@ UCOL_HIRAGANA_QUATERNARY_MODE
When turned on, this attribute positions Hiragana before all non-ignorables on quaternary level Thi...
Definition: ucol.h:326
@ UCOL_DECOMPOSITION_MODE
An alias for UCOL_NORMALIZATION_MODE attribute.
Definition: ucol.h:296
@ UCOL_ATTRIBUTE_COUNT
One more than the highest normal UColAttribute value.
Definition: ucol.h:355
@ UCOL_ALTERNATE_HANDLING
Attribute for handling variable elements.
Definition: ucol.h:263
@ UCOL_NORMALIZATION_MODE
Controls whether the normalization check and necessary normalizations are performed.
Definition: ucol.h:292
U_CAPI int32_t ucol_getSortKey(const UCollator *coll, const UChar *source, int32_t sourceLength, uint8_t *result, int32_t resultLength)
Get a sort key for a string from a UCollator.
int32_t ucol_getContractions(const UCollator *coll, USet *conts, UErrorCode *status)
Get a set containing the contractions defined by the collator.
U_CAPI USet * ucol_getTailoredSet(const UCollator *coll, UErrorCode *status)
Get a Unicode set that contains all the characters and sequences tailored in this collator.
U_CAPI UCollationResult ucol_strcoll(const UCollator *coll, const UChar *source, int32_t sourceLength, const UChar *target, int32_t targetLength)
Compare two strings.
UColAttributeValue UCollationStrength
Base letter represents a primary difference.
Definition: ucol.h:239
U_CAPI int32_t ucol_getBound(const uint8_t *source, int32_t sourceLength, UColBoundMode boundType, uint32_t noOfLevels, uint8_t *result, int32_t resultLength, UErrorCode *status)
Produce a bound for a given sortkey and a number of levels.
U_CAPI UCollationResult ucol_strcollIter(const UCollator *coll, UCharIterator *sIter, UCharIterator *tIter, UErrorCode *status)
Compare two UTF-8 encoded strings.
U_CAPI const UChar * ucol_getRules(const UCollator *coll, int32_t *length)
Get the collation tailoring rules from a UCollator.
int32_t ucol_getShortDefinitionString(const UCollator *coll, const char *locale, char *buffer, int32_t capacity, UErrorCode *status)
Get the short definition string for a collator.
U_CAPI UBool ucol_equal(const UCollator *coll, const UChar *source, int32_t sourceLength, const UChar *target, int32_t targetLength)
Compare two strings for equality.
U_CAPI const char * ucol_getAvailable(int32_t localeIndex)
Get a locale for which collation rules are available.
U_CAPI UEnumeration * ucol_getKeywords(UErrorCode *status)
Create a string enumerator of all possible keywords that are relevant to collation.
UCollator * ucol_openFromShortString(const char *definition, UBool forceDefaults, UParseError *parseError, UErrorCode *status)
Open a collator defined by a short form string.
const char * ucol_getLocale(const UCollator *coll, ULocDataLocaleType type, UErrorCode *status)
gets the locale name of the collator.
U_CAPI int32_t ucol_cloneBinary(const UCollator *coll, uint8_t *buffer, int32_t capacity, UErrorCode *status)
Creates a binary image of a collator.
U_CAPI UCollationResult ucol_strcollUTF8(const UCollator *coll, const char *source, int32_t sourceLength, const char *target, int32_t targetLength, UErrorCode *status)
Compare two strings in UTF-8.
U_CAPI void ucol_prepareShortStringOpen(const char *definition, UBool forceDefaults, UParseError *parseError, UErrorCode *status)
Touches all resources needed for instantiating a collator from a short string definition,...
U_CAPI UBool ucol_greater(const UCollator *coll, const UChar *source, int32_t sourceLength, const UChar *target, int32_t targetLength)
Determine if one string is greater than another.
UCollationResult
UCOL_LESS is returned if source string is compared to be less than target string in the ucol_strcoll(...
Definition: ucol.h:76
@ UCOL_LESS
string a < string b
Definition: ucol.h:82
@ UCOL_GREATER
string a > string b
Definition: ucol.h:80
@ UCOL_EQUAL
string a == string b
Definition: ucol.h:78
UCollator * ucol_safeClone(const UCollator *coll, void *stackBuffer, int32_t *pBufferSize, UErrorCode *status)
Thread safe cloning operation.
U_CAPI int32_t ucol_nextSortKeyPart(const UCollator *coll, UCharIterator *iter, uint32_t state[2], uint8_t *dest, int32_t count, UErrorCode *status)
Gets the next count bytes of a sort key.
UColBoundMode
enum that is taken by ucol_getBound API See below for explanation do not change the values assigned...
Definition: ucol.h:1061
@ UCOL_BOUND_LOWER
lower bound
Definition: ucol.h:1063
@ UCOL_BOUND_UPPER
upper bound that will match strings of exact size
Definition: ucol.h:1065
@ UCOL_BOUND_VALUE_COUNT
One more than the highest normal UColBoundMode value.
Definition: ucol.h:1073
@ UCOL_BOUND_UPPER_LONG
upper bound that will match all the strings that have the same initial substring as the given string
Definition: ucol.h:1067
U_CAPI int32_t ucol_countAvailable(void)
Determine how many locales have collation rules available.
U_CAPI UCollator * ucol_clone(const UCollator *coll, UErrorCode *status)
Thread safe cloning operation.
U_CAPI UBool ucol_greaterOrEqual(const UCollator *coll, const UChar *source, int32_t sourceLength, const UChar *target, int32_t targetLength)
Determine if one string is greater than or equal to another.
U_CAPI int32_t ucol_getEquivalentReorderCodes(int32_t reorderCode, int32_t *dest, int32_t destCapacity, UErrorCode *pErrorCode)
Retrieves the reorder codes that are grouped with the given reorder code.
U_CAPI void ucol_close(UCollator *coll)
Close a UCollator.
U_CAPI int32_t ucol_getFunctionalEquivalent(char *result, int32_t resultCapacity, const char *keyword, const char *locale, UBool *isAvailable, UErrorCode *status)
Return the functionally equivalent locale for the specified input locale, with respect to given keywo...
U_CAPI UCollator * ucol_openRules(const UChar *rules, int32_t rulesLength, UColAttributeValue normalizationMode, UCollationStrength strength, UParseError *parseError, UErrorCode *status)
Produce a UCollator instance according to the rules supplied.
U_CAPI void ucol_getUCAVersion(const UCollator *coll, UVersionInfo info)
Gets the UCA version information for a Collator.
U_CAPI int32_t ucol_getDisplayName(const char *objLoc, const char *dispLoc, UChar *result, int32_t resultLength, UErrorCode *status)
Get the display name for a UCollator.
UColAttributeValue
Enum containing attribute values for controlling collation behavior.
Definition: ucol.h:92
@ UCOL_UPPER_FIRST
upper case sorts before lower case
Definition: ucol.h:129
@ UCOL_TERTIARY
Tertiary collation strength.
Definition: ucol.h:101
@ UCOL_DEFAULT
accepted by most attributes
Definition: ucol.h:94
@ UCOL_IDENTICAL
Identical collation strength.
Definition: ucol.h:108
@ UCOL_OFF
Turn the feature off - works for UCOL_FRENCH_COLLATION, UCOL_CASE_LEVEL, UCOL_HIRAGANA_QUATERNARY_MOD...
Definition: ucol.h:114
@ UCOL_QUATERNARY
Quaternary collation strength.
Definition: ucol.h:106
@ UCOL_SHIFTED
Valid for UCOL_ALTERNATE_HANDLING.
Definition: ucol.h:121
@ UCOL_PRIMARY
Primary collation strength.
Definition: ucol.h:97
@ UCOL_LOWER_FIRST
Valid for UCOL_CASE_FIRST - lower case sorts before upper case.
Definition: ucol.h:127
@ UCOL_ATTRIBUTE_VALUE_COUNT
One more than the highest normal UColAttributeValue value.
Definition: ucol.h:136
@ UCOL_SECONDARY
Secondary collation strength.
Definition: ucol.h:99
@ UCOL_NON_IGNORABLE
Valid for UCOL_ALTERNATE_HANDLING.
Definition: ucol.h:123
@ UCOL_ON
Turn the feature on - works for UCOL_FRENCH_COLLATION, UCOL_CASE_LEVEL, UCOL_HIRAGANA_QUATERNARY_MODE...
Definition: ucol.h:118
@ UCOL_DEFAULT_STRENGTH
Default collation strength.
Definition: ucol.h:103
void ucol_restoreVariableTop(UCollator *coll, const uint32_t varTop, UErrorCode *status)
Sets the variable top to the specified primary weight.
U_CAPI UCollationStrength ucol_getStrength(const UCollator *coll)
Get the collation strength used in a UCollator.
U_CAPI int32_t ucol_getReorderCodes(const UCollator *coll, int32_t *dest, int32_t destCapacity, UErrorCode *pErrorCode)
Retrieves the reordering codes for this collator.
U_CAPI void ucol_setReorderCodes(UCollator *coll, const int32_t *reorderCodes, int32_t reorderCodesLength, UErrorCode *pErrorCode)
Sets the reordering codes for this collator.
UColReorderCode
Enum containing the codes for reordering segments of the collation table that are not script codes.
Definition: ucol.h:149
@ UCOL_REORDER_CODE_OTHERS
A special reordering code that is used to specify all other codes used for reordering except for the ...
Definition: ucol.h:167
@ UCOL_REORDER_CODE_NONE
A special reordering code that is used to specify no reordering codes.
Definition: ucol.h:160
@ UCOL_REORDER_CODE_DEFAULT
A special reordering code that is used to specify the default reordering codes for a locale.
Definition: ucol.h:155
@ UCOL_REORDER_CODE_LIMIT
One more than the highest normal UColReorderCode value.
Definition: ucol.h:209
@ UCOL_REORDER_CODE_SYMBOL
Characters with the symbol property.
Definition: ucol.h:191
@ UCOL_REORDER_CODE_DIGIT
Characters with the digit property.
Definition: ucol.h:203
@ UCOL_REORDER_CODE_PUNCTUATION
Characters with the punctuation property.
Definition: ucol.h:185
@ UCOL_REORDER_CODE_SPACE
Characters with the space property.
Definition: ucol.h:173
@ UCOL_REORDER_CODE_FIRST
The first entry in the enumeration of reordering groups.
Definition: ucol.h:179
@ UCOL_REORDER_CODE_CURRENCY
Characters with the currency property.
Definition: ucol.h:197
U_CAPI UEnumeration * ucol_getKeywordValues(const char *keyword, UErrorCode *status)
Given a keyword, create a string enumeration of all values for that keyword that are currently in use...
U_CAPI UEnumeration * ucol_getKeywordValuesForLocale(const char *key, const char *locale, UBool commonlyUsed, UErrorCode *status)
Given a key and a locale, returns an array of string values in a preferred order that would make a di...
U_CAPI int32_t ucol_mergeSortkeys(const uint8_t *src1, int32_t src1Length, const uint8_t *src2, int32_t src2Length, uint8_t *dest, int32_t destCapacity)
Merges two sort keys.
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition: uenum.h:44
C API: Locale.
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested,...
Definition: uloc.h:338
#define U_DEPRECATED
This is used to declare a function as a deprecated public ICU C API
Definition: umachine.h:116
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:110
char16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:412
C API: Unicode Normalization.
C API: Unicode Script Information.
@ USCRIPT_UNKNOWN
Definition: uscript.h:287
C API: Unicode Set.
struct USet USet
USet is the C API type corresponding to C++ class UnicodeSet.
Definition: uset.h:50
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
uint8_t UVersionInfo[U_MAX_VERSION_LENGTH]
The binary form of a version on ICU APIs is an array of 4 uint8_t.
Definition: uversion.h:59