ucoleitr.h
Go to the documentation of this file.
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
* Copyright (C) 2001-2014, International Business Machines
* Corporation and others. All Rights Reserved.
*******************************************************************************
*
* File ucoleitr.h
*
* Modification History:
*
* Date Name Description
* 02/15/2001 synwee Modified all methods to process its own function
* instead of calling the equivalent c++ api (coleitr.h)
*******************************************************************************/
#ifndef UCOLEITR_H
#define UCOLEITR_H
#include "unicode/utypes.h"
#if !UCONFIG_NO_COLLATION
#define UCOL_NULLORDER ((int32_t)0xFFFFFFFF)
#include "unicode/ucol.h"
typedef struct UCollationElements UCollationElements;
U_CAPI UCollationElements* U_EXPORT2
ucol_openElements(const UCollator *coll,
const UChar *text,
int32_t textLength,
UErrorCode *status);
U_CAPI int32_t U_EXPORT2
ucol_keyHashCode(const uint8_t* key, int32_t length);
U_CAPI void U_EXPORT2
ucol_closeElements(UCollationElements *elems);
U_CAPI void U_EXPORT2
ucol_reset(UCollationElements *elems);
U_CAPI int32_t U_EXPORT2
ucol_next(UCollationElements *elems, UErrorCode *status);
U_CAPI int32_t U_EXPORT2
ucol_previous(UCollationElements *elems, UErrorCode *status);
U_CAPI int32_t U_EXPORT2
ucol_getMaxExpansion(const UCollationElements *elems, int32_t order);
U_CAPI void U_EXPORT2
ucol_setText( UCollationElements *elems,
const UChar *text,
int32_t textLength,
UErrorCode *status);
U_CAPI int32_t U_EXPORT2
ucol_getOffset(const UCollationElements *elems);
U_CAPI void U_EXPORT2
ucol_setOffset(UCollationElements *elems,
int32_t offset,
UErrorCode *status);
U_CAPI int32_t U_EXPORT2
ucol_primaryOrder (int32_t order);
U_CAPI int32_t U_EXPORT2
ucol_secondaryOrder (int32_t order);
U_CAPI int32_t U_EXPORT2
ucol_tertiaryOrder (int32_t order);
#endif /* #if !UCONFIG_NO_COLLATION */
#endif
ucol.h
C API: Collator.
UCollator
struct UCollator UCollator
structure representing a collator object instance
Definition: ucol.h:61
ucol_next
U_CAPI int32_t ucol_next(UCollationElements *elems, UErrorCode *status)
Get the ordering priority of the next collation element in the text.
ucol_primaryOrder
U_CAPI int32_t ucol_primaryOrder(int32_t order)
Get the primary order of a collation order.
ucol_setText
U_CAPI void ucol_setText(UCollationElements *elems, const UChar *text, int32_t textLength, UErrorCode *status)
Set the text containing the collation elements.
ucol_tertiaryOrder
U_CAPI int32_t ucol_tertiaryOrder(int32_t order)
Get the tertiary order of a collation order.
ucol_reset
U_CAPI void ucol_reset(UCollationElements *elems)
Reset the collation elements to their initial state.
UCollationElements
struct UCollationElements UCollationElements
The UCollationElements struct.
Definition: ucoleitr.h:39
ucol_getOffset
U_CAPI int32_t ucol_getOffset(const UCollationElements *elems)
Get the offset of the current source character.
ucol_getMaxExpansion
U_CAPI int32_t ucol_getMaxExpansion(const UCollationElements *elems, int32_t order)
Get the maximum length of any expansion sequences that end with the specified comparison order.
ucol_openElements
U_CAPI UCollationElements * ucol_openElements(const UCollator *coll, const UChar *text, int32_t textLength, UErrorCode *status)
Open the collation elements for a string.
ucol_previous
U_CAPI int32_t ucol_previous(UCollationElements *elems, UErrorCode *status)
Get the ordering priority of the previous collation element in the text.
ucol_secondaryOrder
U_CAPI int32_t ucol_secondaryOrder(int32_t order)
Get the secondary order of a collation order.
ucol_setOffset
U_CAPI void ucol_setOffset(UCollationElements *elems, int32_t offset, UErrorCode *status)
Set the offset of the current source character.
ucol_closeElements
U_CAPI void ucol_closeElements(UCollationElements *elems)
Close a UCollationElements.
ucol_keyHashCode
U_CAPI int32_t ucol_keyHashCode(const uint8_t *key, int32_t length)
get a hash code for a key...
U_CAPI
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:110
UChar
char16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:386
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