OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	10/21/2025 06:56:31 AM	rwxr-xr-x
📄 alphaindex.h	26.54 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 appendable.h	8.54 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 basictz.h	9.99 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 brkiter.h	27.84 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 bytestream.h	10.77 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 bytestrie.h	20.83 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 bytestriebuilder.h	7.48 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 calendar.h	107.54 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 caniter.h	7.53 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 casemap.h	25.42 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 char16ptr.h	10.79 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 chariter.h	23.79 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 choicfmt.h	23.99 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 coleitr.h	13.78 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 coll.h	59.6 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 compactdecimalformat.h	6.88 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 curramt.h	3.67 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 currpinf.h	7.3 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 currunit.h	4.02 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 datefmt.h	40.7 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 dbbi.h	1.19 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 dcfmtsym.h	20.96 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 decimfmt.h	87.46 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 displayoptions.h	7.08 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 docmain.h	7.6 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 dtfmtsym.h	38.22 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 dtintrv.h	3.84 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 dtitvfmt.h	48.87 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 dtitvinf.h	18.63 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 dtptngen.h	28.05 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 dtrule.h	8.66 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 edits.h	20.74 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 enumset.h	2.08 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 errorcode.h	4.84 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 fieldpos.h	8.69 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 filteredbrk.h	5.37 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 fmtable.h	24.37 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 format.h	12.51 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 formattednumber.h	6.28 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 formattedvalue.h	9.75 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 fpositer.h	3.03 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 gender.h	3.35 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 gregocal.h	30.32 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 icudataver.h	1.02 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 icuplug.h	12.1 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 idna.h	12.93 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 listformatter.h	8.59 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 localebuilder.h	11.08 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 localematcher.h	26.86 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 localpointer.h	19.55 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 locdspnm.h	7.12 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 locid.h	48.62 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 measfmt.h	11.41 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 measunit.h	111.44 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 measure.h	4.63 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 messageformat2.h	21.05 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 messageformat2_arguments.h	4.49 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 messageformat2_data_model.h	101.89 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 messageformat2_data_model_names.h	784 bytes	06/06/2025 11:36:00 AM	rw-r--r--
📄 messageformat2_formattable.h	38.36 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 messageformat2_function_registry.h	18.07 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 messagepattern.h	33.79 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 msgfmt.h	44.2 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 normalizer2.h	34.68 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 normlzr.h	30.79 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 nounit.h	2.24 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 numberformatter.h	90.69 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 numberrangeformatter.h	26 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 numfmt.h	50.16 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 numsys.h	7.22 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 parseerr.h	3.08 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 parsepos.h	5.56 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 platform.h	27.18 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 plurfmt.h	25.07 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 plurrule.h	20.63 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ptypes.h	2.16 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 putil.h	6.32 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 rbbi.h	32.04 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 rbnf.h	56.16 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 rbtz.h	15.75 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 regex.h	84.45 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 region.h	9.2 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 reldatefmt.h	22.48 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 rep.h	9.38 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 resbund.h	18.02 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 schriter.h	6.09 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 scientificnumberformatter.h	6.44 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 search.h	22.21 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 selfmt.h	14.35 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 simpleformatter.h	12.6 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 simplenumberformatter.h	8.87 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 simpletz.h	45.62 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 smpdtfmt.h	57.06 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 sortkey.h	11.13 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 std_string.h	1.05 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 strenum.h	9.96 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 stringoptions.h	5.79 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 stringpiece.h	10.28 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 stringtriebuilder.h	15.53 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 stsearch.h	21.43 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 symtable.h	4.28 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 tblcoll.h	36.96 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 timezone.h	45.59 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 tmunit.h	3.4 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 tmutamt.h	4.9 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 tmutfmt.h	7.42 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 translit.h	65.81 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 tzfmt.h	42.95 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 tznames.h	16.85 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 tzrule.h	34.81 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 tztrans.h	6.11 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ubidi.h	89.61 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ubiditransform.h	12.71 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ubrk.h	24.43 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ucal.h	63.96 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ucasemap.h	15.27 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ucat.h	5.35 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uchar.h	151.74 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ucharstrie.h	22.59 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ucharstriebuilder.h	7.48 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uchriter.h	13.24 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uclean.h	11.21 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ucnv.h	83.34 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ucnv_cb.h	6.58 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ucnv_err.h	20.98 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ucnvsel.h	6.24 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ucol.h	67.28 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ucoleitr.h	9.82 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uconfig.h	12.56 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ucpmap.h	5.54 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ucptrie.h	22.51 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ucsdet.h	14.69 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ucurr.h	16.72 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 udat.h	62.36 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 udata.h	15.63 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 udateintervalformat.h	11.93 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 udatpg.h	30.13 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 udisplaycontext.h	5.94 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 udisplayoptions.h	8.86 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uenum.h	7.79 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ufieldpositer.h	4.41 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uformattable.h	10.97 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uformattednumber.h	8.09 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uformattedvalue.h	12.25 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ugender.h	2.06 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uidna.h	34.12 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uiter.h	22.75 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uldnames.h	10.48 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ulistformatter.h	10.78 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uloc.h	55.38 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ulocale.h	6.31 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ulocbuilder.h	16.69 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ulocdata.h	11.3 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 umachine.h	14.59 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 umisc.h	1.34 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 umsg.h	24.25 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 umutablecptrie.h	8.3 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 unifilt.h	4 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 unifunct.h	4.05 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 unimatch.h	6.1 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 unirepl.h	3.38 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uniset.h	70.4 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 unistr.h	182.08 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 unorm.h	20.55 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 unorm2.h	25.66 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 unum.h	55.16 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 unumberformatter.h	19.68 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 unumberoptions.h	5.23 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 unumberrangeformatter.h	15.35 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 unumsys.h	7.26 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uobject.h	10.66 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 upluralrules.h	8.79 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uregex.h	71.99 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uregion.h	9.81 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ureldatefmt.h	16.98 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 urename.h	141.99 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 urep.h	5.38 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ures.h	36.65 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uscript.h	28.51 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 usearch.h	39.21 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uset.h	63.08 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 usetiter.h	9.63 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ushape.h	18 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 usimplenumberformatter.h	7.31 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uspoof.h	80 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 usprep.h	8.19 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ustdio.h	38.58 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ustream.h	1.89 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ustring.h	72.16 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 ustringtrie.h	3.15 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 utext.h	58.1 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 utf.h	7.87 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 utf16.h	23.35 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 utf32.h	763 bytes	06/06/2025 11:36:00 AM	rw-r--r--
📄 utf8.h	30.83 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 utf_old.h	45.8 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 utmscale.h	13.78 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 utrace.h	17.18 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 utrans.h	25.54 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 utypes.h	34.48 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uvernum.h	6.33 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 uversion.h	8.21 KB	06/06/2025 11:36:00 AM	rw-r--r--
📄 vtzone.h	20.68 KB	06/06/2025 11:36:00 AM	rw-r--r--

Editing: ucoleitr.h

// © 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

/**  
 * This indicates an error has occurred during processing or if no more CEs is 
 * to be returned.
 * @stable ICU 2.0
 */
#define UCOL_NULLORDER        ((int32_t)0xFFFFFFFF)

#include "unicode/ucol.h"

/** 
 * The UCollationElements struct.
 * For usage in C programs.
 * @stable ICU 2.0
 */
typedef struct UCollationElements UCollationElements;

/**
 * \file
 * \brief C API: UCollationElements
 *
 * The UCollationElements API is used as an iterator to walk through each 
 * character of an international string. Use the iterator to return the
 * ordering priority of the positioned character. The ordering priority of a 
 * character, which we refer to as a key, defines how a character is collated 
 * in the given collation object.
 * For example, consider the following in Slovak and in traditional Spanish collation:
 * <pre>
 * .       "ca" -> the first key is key('c') and second key is key('a').
 * .       "cha" -> the first key is key('ch') and second key is key('a').
 * </pre>
 * And in German phonebook collation,
 * <pre>
 * .       "<ae ligature>b"-> the first key is key('a'), the second key is key('e'), and
 * .       the third key is key('b').
 * </pre>
 * <p>Example of the iterator usage: (without error checking)
 * <pre>
 * .  void CollationElementIterator_Example()
 * .  {
 * .      UChar *s;
 * .      t_int32 order, primaryOrder;
 * .      UCollationElements *c;
 * .      UCollatorOld *coll;
 * .      UErrorCode success = U_ZERO_ERROR;
 * .      str=(UChar*)malloc(sizeof(UChar) * (strlen("This is a test")+1) );
 * .      u_uastrcpy(str, "This is a test");
 * .      coll = ucol_open(NULL, &success);
 * .      c = ucol_openElements(coll, str, u_strlen(str), &status);
 * .      order = ucol_next(c, &success);
 * .      ucol_reset(c);
 * .      order = ucol_prev(c, &success);
 * .      free(str);
 * .      ucol_close(coll);
 * .      ucol_closeElements(c);
 * .  }
 * </pre>
 * <p>
 * ucol_next() returns the collation order of the next.
 * ucol_prev() returns the collation order of the previous character.
 * The Collation Element Iterator moves only in one direction between calls to
 * ucol_reset. That is, ucol_next() and ucol_prev can not be inter-used. 
 * Whenever ucol_prev is to be called after ucol_next() or vice versa, 
 * ucol_reset has to be called first to reset the status, shifting pointers to 
 * either the end or the start of the string. Hence at the next call of 
 * ucol_prev or ucol_next, the first or last collation order will be returned. 
 * If a change of direction is done without a ucol_reset, the result is 
 * undefined.
 * The result of a forward iterate (ucol_next) and reversed result of the  
 * backward iterate (ucol_prev) on the same string are equivalent, if 
 * collation orders with the value 0 are ignored.
 * Character based on the comparison level of the collator.  A collation order 
 * consists of primary order, secondary order and tertiary order.  The data 
 * type of the collation order is <strong>int32_t</strong>. 
 *
 * @see UCollator
 */

/**
 * Open the collation elements for a string.
 *
 * The UCollationElements retains a pointer to the supplied text.
 * The caller must not modify or delete the text while the UCollationElements
 * object is used to iterate over this text.
 *
 * @param coll The collator containing the desired collation rules.
 * @param text The text to iterate over.
 * @param textLength The number of characters in text, or -1 if null-terminated
 * @param status A pointer to a UErrorCode to receive any errors.
 * @return a struct containing collation element information
 * @stable ICU 2.0
 */
U_CAPI UCollationElements* U_EXPORT2 
ucol_openElements(const UCollator  *coll,
                  const UChar      *text,
                        int32_t    textLength,
                        UErrorCode *status);

/**
 * get a hash code for a key... Not very useful!
 * @param key    the given key.
 * @param length the size of the key array.
 * @return       the hash code.
 * @stable ICU 2.0
 */
U_CAPI int32_t U_EXPORT2 
ucol_keyHashCode(const uint8_t* key, int32_t length);

/**
 * Close a UCollationElements.
 * Once closed, a UCollationElements may no longer be used.
 * @param elems The UCollationElements to close.
 * @stable ICU 2.0
 */
U_CAPI void U_EXPORT2 
ucol_closeElements(UCollationElements *elems);

/**
 * Reset the collation elements to their initial state.
 * This will move the 'cursor' to the beginning of the text.
 * Property settings for collation will be reset to the current status.
 * @param elems The UCollationElements to reset.
 * @see ucol_next
 * @see ucol_previous
 * @stable ICU 2.0
 */
U_CAPI void U_EXPORT2 
ucol_reset(UCollationElements *elems);

/**
 * Get the ordering priority of the next collation element in the text.
 * A single character may contain more than one collation element.
 * @param elems The UCollationElements containing the text.
 * @param status A pointer to a UErrorCode to receive any errors.
 * @return The next collation elements ordering, otherwise returns UCOL_NULLORDER 
 *         if an error has occurred or if the end of string has been reached
 * @stable ICU 2.0
 */
U_CAPI int32_t U_EXPORT2 
ucol_next(UCollationElements *elems, UErrorCode *status);

/**
 * Get the ordering priority of the previous collation element in the text.
 * A single character may contain more than one collation element.
 * Note that internally a stack is used to store buffered collation elements. 
 * @param elems The UCollationElements containing the text.
 * @param status A pointer to a UErrorCode to receive any errors. Notably 
 *               a U_BUFFER_OVERFLOW_ERROR is returned if the internal stack
 *               buffer has been exhausted.
 * @return The previous collation elements ordering, otherwise returns 
 *         UCOL_NULLORDER if an error has occurred or if the start of string has 
 *         been reached.
 * @stable ICU 2.0
 */
U_CAPI int32_t U_EXPORT2 
ucol_previous(UCollationElements *elems, UErrorCode *status);

/**
 * Get the maximum length of any expansion sequences that end with the 
 * specified comparison order.
 * This is useful for .... ?
 * @param elems The UCollationElements containing the text.
 * @param order A collation order returned by previous or next.
 * @return maximum size of the expansion sequences ending with the collation 
 *         element or 1 if collation element does not occur at the end of any 
 *         expansion sequence
 * @stable ICU 2.0
 */
U_CAPI int32_t U_EXPORT2 
ucol_getMaxExpansion(const UCollationElements *elems, int32_t order);

/**
 * Set the text containing the collation elements.
 * Property settings for collation will remain the same.
 * In order to reset the iterator to the current collation property settings,
 * the API reset() has to be called.
 *
 * The UCollationElements retains a pointer to the supplied text.
 * The caller must not modify or delete the text while the UCollationElements
 * object is used to iterate over this text.
 *
 * @param elems The UCollationElements to set.
 * @param text The source text containing the collation elements.
 * @param textLength The length of text, or -1 if null-terminated.
 * @param status A pointer to a UErrorCode to receive any errors.
 * @see ucol_getText
 * @stable ICU 2.0
 */
U_CAPI void U_EXPORT2 
ucol_setText(      UCollationElements *elems,
             const UChar              *text,
                   int32_t            textLength,
                   UErrorCode         *status);

/**
 * Get the offset of the current source character.
 * This is an offset into the text of the character containing the current
 * collation elements.
 * @param elems The UCollationElements to query.
 * @return The offset of the current source character.
 * @see ucol_setOffset
 * @stable ICU 2.0
 */
U_CAPI int32_t U_EXPORT2 
ucol_getOffset(const UCollationElements *elems);

/**
 * Set the offset of the current source character.
 * This is an offset into the text of the character to be processed.
 * Property settings for collation will remain the same.
 * In order to reset the iterator to the current collation property settings,
 * the API reset() has to be called.
 * @param elems The UCollationElements to set.
 * @param offset The desired character offset.
 * @param status A pointer to a UErrorCode to receive any errors.
 * @see ucol_getOffset
 * @stable ICU 2.0
 */
U_CAPI void U_EXPORT2 
ucol_setOffset(UCollationElements *elems,
               int32_t             offset,
               UErrorCode         *status);

/**
* Get the primary order of a collation order.
* @param order the collation order
* @return the primary order of a collation order.
* @stable ICU 2.6
*/
U_CAPI int32_t U_EXPORT2
ucol_primaryOrder (int32_t order);

/**
* Get the secondary order of a collation order.
* @param order the collation order
* @return the secondary order of a collation order.
* @stable ICU 2.6
*/
U_CAPI int32_t U_EXPORT2
ucol_secondaryOrder (int32_t order);

/**
* Get the tertiary order of a collation order.
* @param order the collation order
* @return the tertiary order of a collation order.
* @stable ICU 2.6
*/
U_CAPI int32_t U_EXPORT2
ucol_tertiaryOrder (int32_t order);

#endif /* #if !UCONFIG_NO_COLLATION */

#endif