<!-- This comment will put IE 6, 7 and 8 in quirks mode --> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>ICU 4.4.1: Main Page</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javaScript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.6.2-20100208 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div class="navigation" id="top"> <div class="tabs"> <ul> <li class="current"><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <img id="MSearchSelect" src="search/search.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </div> </li> </ul> </div> </div> <div class="contents"> <h1>ICU 4.4.1 Documentation</h1><h3 class="version">4.4.1 </h3><h2><a class="anchor" id="API"> API Reference Usage</a></h2> <h3>C++ Programmers:</h3> <p>Use <a href="hierarchy.html">Class Hierarchy</a> or <a href="classes.html">Alphabetical List </a> or <a href="annotated.html">Compound List</a> to find the class you are interested in. For example, to find <a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a>, you can go to the <a href="classes.html">Alphabetical List</a>, then click on "BreakIterator". Once you are at the class, you will find an inheritance chart, a list of the public members, a detailed description of the class, then detailed member descriptions.</p> <h3>C Programmers:</h3> <p>Use <a href="#Module">Module List</a> or <a href="globals.html">File Members</a> to find a list of all the functions and constants. For example, to find <a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> functions you would click on <a href="files.html">File List</a>, then find "ubrk.h" and click on it. You will find descriptions of Defines, Typedefs, Enumerations, and Functions, with detailed descriptions below. If you want to find a specific function, such as <a class="el" href="ubrk_8h.html#a17158fccedcf72481eaca61fffab4ce6" title="Determine the text boundary following the current text boundary.">ubrk_next()</a>, then click first on <a href="globals.html">File Members</a>, then use your browser Find dialog to search for "ubrk_next()".</p> <h3>API References for Previous Releases</h3> <p>The API References for each release of ICU are also available as a zip file from the ICU <a href="http://icu-project.org/download/">download page</a>.</p> <hr/> <h2>Architecture (User's Guide)</h2> <ul> <li> <a href="http://icu-project.org/userguide/">Introduction</a> </li> <li> <a href="http://icu-project.org/userguide/i18n.html">Internationalization</a> </li> <li> <a href="http://icu-project.org/userguide/design.html">Locale Model</a> </li> <li> <a href="http://icu-project.org/userguide/design.html">Multithreading</a> </li> <li> <a href="http://icu-project.org/userguide/conversion.html">Conversion</a> </li> <li> <a href="http://icu-project.org/userguide/design.html">Error Handling</a> </li> </ul> <hr/> <h2><a NAME="Module">Module List</a></h2> <table border="1" cols="3" align="center"> <tr> <td><b>Module Name</b> </td><td><b>C</b> </td><td><b>C++</b> </td></tr> <tr> <td>Basic Types and Constants </td><td><a class="el" href="utypes_8h.html" title="Basic definitions for ICU, for both C and C++ APIs.">utypes.h</a> </td><td><a class="el" href="utypes_8h.html" title="Basic definitions for ICU, for both C and C++ APIs.">utypes.h</a> </td></tr> <tr> <td>Strings and Character Iteration </td><td><a class="el" href="ustring_8h.html" title="C API: Unicode string handling functions.">ustring.h</a>, <a class="el" href="utf_8h.html" title="C API: Code point macros.">utf.h</a> </td><td><a class="el" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>, <a class="el" href="classCharacterIterator.html" title="Abstract class that defines an API for iteration on text objects.">CharacterIterator</a> </td></tr> <tr> <td>Unicode Character<br/> Properties and Names </td><td><a class="el" href="uchar_8h.html" title="C API: Unicode Properties.">uchar.h</a> </td><td><a class="el" href="uchar_8h.html" title="C API: Unicode Properties.">uchar.h</a> C API </td></tr> <tr> <td>Codepage Conversion </td><td><a class="el" href="ucnv_8h.html" title="C API: Character conversion.">ucnv.h</a> </td><td><a class="el" href="ucnv_8h.html" title="C API: Character conversion.">ucnv.h</a> C API </td></tr> <tr> <td>Unicode Text Compression </td><td><a class="el" href="ucnv_8h.html" title="C API: Character conversion.">ucnv.h</a> <br/> (encoding name "SCSU" or "BOCU-1") </td><td><a class="el" href="ucnv_8h.html" title="C API: Character conversion.">ucnv.h</a> C API </td></tr> <tr> <td>Locales </td><td><a class="el" href="uloc_8h.html" title="C API: Locale.">uloc.h</a> </td><td><a class="el" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region...">Locale</a> </td></tr> <tr> <td>Resource Bundles </td><td><a class="el" href="ures_8h.html" title="C API: Resource Bundle.">ures.h</a> </td><td><a class="el" href="classResourceBundle.html" title="A class representing a collection of resource information pertaining to a given locale...">ResourceBundle</a> </td></tr> <tr> <td>Normalization </td><td><a class="el" href="unorm_8h.html" title="C API: Unicode Normalization.">unorm.h</a> </td><td><a class="el" href="classNormalizer.html" title="The Normalizer class supports the standard normalization forms described in Unicode...">Normalizer</a> </td></tr> <tr> <td>Calendars </td><td><a class="el" href="ucal_8h.html" title="C API: Calendar.">ucal.h</a> </td><td><a class="el" href="classCalendar.html" title="Calendar is an abstract base class for converting between a UDate object and a set...">Calendar</a> </td></tr> <tr> <td>Date and Time Formatting </td><td><a class="el" href="udat_8h.html" title="C API: DateFormat.">udat.h</a> </td><td><a class="el" href="classDateFormat.html" title="DateFormat is an abstract class for a family of classes that convert dates and times...">DateFormat</a> </td></tr> <tr> <td>Message Formatting </td><td><a class="el" href="umsg_8h.html" title="C API: MessageFormat.">umsg.h</a> </td><td><a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> </td></tr> <tr> <td>Number Formatting </td><td><a class="el" href="unum_8h.html" title="C API: NumberFormat.">unum.h</a> </td><td><a class="el" href="classNumberFormat.html" title="Abstract base class for all number formats.">NumberFormat</a> </td></tr> <tr> <td>Number Spellout <br/> (Rule Based Number Formatting) </td><td><a class="el" href="unum_8h.html" title="C API: NumberFormat.">unum.h</a> <br/> (use UNUM_SPELLOUT) </td><td><a class="el" href="classRuleBasedNumberFormat.html" title="The RuleBasedNumberFormat class formats numbers according to a set of rules.">RuleBasedNumberFormat</a> </td></tr> <tr> <td>Text Transformation <br/> (Transliteration) </td><td><a class="el" href="utrans_8h.html" title="C API: Transliterator.">utrans.h</a> </td><td><a class="el" href="classTransliterator.html" title="Transliterator is an abstract class that transliterates text from one format to another...">Transliterator</a> </td></tr> <tr> <td>Bidirectional Algorithm </td><td><a class="el" href="ubidi_8h.html" title="C API: Bidi algorithm.">ubidi.h</a> </td><td><a class="el" href="ubidi_8h.html" title="C API: Bidi algorithm.">ubidi.h</a> C API </td></tr> <tr> <td>Arabic Shaping </td><td><a class="el" href="ushape_8h.html" title="C API: Arabic shaping.">ushape.h</a> </td><td><a class="el" href="ushape_8h.html" title="C API: Arabic shaping.">ushape.h</a> C API </td></tr> <tr> <td>Collation </td><td><a class="el" href="ucol_8h.html" title="C API: Collator.">ucol.h</a> </td><td><a class="el" href="classCollator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> </td></tr> <tr> <td>String Searching </td><td><a class="el" href="usearch_8h.html" title="C API: StringSearch.">usearch.h</a> </td><td><a class="el" href="classStringSearch.html" title="StringSearch is a SearchIterator that provides language-sensitive text searching...">StringSearch</a> </td></tr> <tr> <td>Text Boundary Analysis <br/> (Break Iteration) </td><td><a class="el" href="ubrk_8h.html" title="C API: BreakIterator.">ubrk.h</a> </td><td><a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> </td></tr> <tr> <td>Unicode Set </td><td><a class="el" href="uset_8h.html" title="C API: Unicode Set.">uset.h</a> </td><td><a class="el" href="classUnicodeSet.html" title="A mutable set of Unicode characters and multicharacter strings.">UnicodeSet</a> </td></tr> <tr> <td>Regular Expressions </td><td><a class="el" href="uregex_8h.html" title="C API: Regular Expressions.">uregex.h</a> </td><td><a class="el" href="classRegexPattern.html" title="Class RegexPattern represents a compiled regular expression.">RegexPattern</a>, <a class="el" href="classRegexMatcher.html" title="class RegexMatcher bundles together a reular expression pattern and input text to...">RegexMatcher</a> </td></tr> <tr> <td>StringPrep </td><td><a class="el" href="usprep_8h.html" title="C API: Implements the StringPrep algorithm.">usprep.h</a> </td><td><a class="el" href="usprep_8h.html" title="C API: Implements the StringPrep algorithm.">usprep.h</a> C API </td></tr> <tr> <td>International Domain Names in Applications </td><td><a class="el" href="uidna_8h.html" title="C API: Internationalized Domain Names in Applications Tranformation.">uidna.h</a> </td><td><a class="el" href="uidna_8h.html" title="C API: Internationalized Domain Names in Applications Tranformation.">uidna.h</a> C API </td></tr> <tr> <td>Universal Time Scale </td><td><a class="el" href="utmscale_8h.html" title="C API: Universal Time Scale.">utmscale.h</a> </td><td><a class="el" href="utmscale_8h.html" title="C API: Universal Time Scale.">utmscale.h</a> C API </td></tr> <tr> <td>Basic Layout Engine Types and Constants </td><td>(no C API) </td><td><a class="el" href="LETypes_8h.html" title="C API: Basic definitions for the ICU LayoutEngine.">LETypes.h</a> </td></tr> <tr> <td>Complex Text Layout </td><td>(no C API) </td><td><a class="el" href="classLayoutEngine.html" title="This is a virtual base class used to do complex text layout.">LayoutEngine</a>, <a class="el" href="classParagraphLayout.html" title="ParagraphLayout.">ParagraphLayout</a> </td></tr> <tr> <td>ICU I/O </td><td><a class="el" href="ustdio_8h.html" title="C API: Unicode stdio-like API.">ustdio.h</a> </td><td><a class="el" href="ustream_8h.html" title="C++ API: Unicode iostream like API.">ustream.h</a> </td></tr> </table> <p><em>This main page is generated from <a class="el" href="docmain_8h_source.html">docmain.h</a></em> </p> </div> <!--- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address> </body> </html>