<!-- 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: uclean.h Source File</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><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 class="current"><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 class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <h1>uclean.h</h1><a href="uclean_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment">******************************************************************************</span> <a name="l00003"></a>00003 <span class="comment">* *</span> <a name="l00004"></a>00004 <span class="comment">* Copyright (C) 2001-2009, International Business Machines *</span> <a name="l00005"></a>00005 <span class="comment">* Corporation and others. All Rights Reserved. *</span> <a name="l00006"></a>00006 <span class="comment">* *</span> <a name="l00007"></a>00007 <span class="comment">******************************************************************************</span> <a name="l00008"></a>00008 <span class="comment">* file name: uclean.h</span> <a name="l00009"></a>00009 <span class="comment">* encoding: US-ASCII</span> <a name="l00010"></a>00010 <span class="comment">* tab size: 8 (not used)</span> <a name="l00011"></a>00011 <span class="comment">* indentation:4</span> <a name="l00012"></a>00012 <span class="comment">*</span> <a name="l00013"></a>00013 <span class="comment">* created on: 2001July05</span> <a name="l00014"></a>00014 <span class="comment">* created by: George Rhoten</span> <a name="l00015"></a>00015 <span class="comment">*/</span> <a name="l00016"></a>00016 <a name="l00017"></a>00017 <span class="preprocessor">#ifndef __UCLEAN_H__</span> <a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __UCLEAN_H__</span> <a name="l00019"></a>00019 <span class="preprocessor"></span> <a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="utypes_8h.html" title="Basic definitions for ICU, for both C and C++ APIs.">unicode/utypes.h</a>"</span> <a name="l00052"></a>00052 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00053"></a>00053 <a class="code" href="uclean_8h.html#ab6a4215b45b2162889aa1ff01e491d4c" title="Initialize ICU.">u_init</a>(<a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> *status); <a name="l00054"></a>00054 <a name="l00100"></a>00100 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00101"></a>00101 <a class="code" href="uclean_8h.html#a93f27d0ddc7c196a1da864763f2d8920" title="Clean up the system resources, such as allocated memory or open files, used in all...">u_cleanup</a>(<span class="keywordtype">void</span>); <a name="l00102"></a>00102 <a name="l00103"></a>00103 <a name="l00104"></a>00104 <a name="l00105"></a>00105 <a name="l00113"></a><a class="code" href="uclean_8h.html#af125d56147c708c2d8ecc5327449c41d">00113</a> <span class="keyword">typedef</span> <span class="keywordtype">void</span> *<a class="code" href="uclean_8h.html#af125d56147c708c2d8ecc5327449c41d" title="An opaque pointer type that represents an ICU mutex.">UMTX</a>; <a name="l00114"></a>00114 <a name="l00131"></a><a class="code" href="uclean_8h.html#a302ac3ea859a593dea50f9a1b06ce5b1">00131</a> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="utypes_8h.html#a1fae478cb5a46c7e4a0673d267626696" title="Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function...">U_CALLCONV</a> <a class="code" href="uclean_8h.html#a302ac3ea859a593dea50f9a1b06ce5b1" title="Function Pointer type for a user supplied mutex initialization function.">UMtxInitFn</a> (<span class="keyword">const</span> <span class="keywordtype">void</span> *context, <a class="code" href="uclean_8h.html#af125d56147c708c2d8ecc5327449c41d" title="An opaque pointer type that represents an ICU mutex.">UMTX</a> *mutex, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a>* status); <a name="l00132"></a>00132 <a name="l00133"></a>00133 <a name="l00143"></a><a class="code" href="uclean_8h.html#a67a2314f542b9f495ef0b2ac1cfd5192">00143</a> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="utypes_8h.html#a1fae478cb5a46c7e4a0673d267626696" title="Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function...">U_CALLCONV</a> <a class="code" href="uclean_8h.html#a67a2314f542b9f495ef0b2ac1cfd5192" title="Function Pointer type for a user supplied mutex functions.">UMtxFn</a> (<span class="keyword">const</span> <span class="keywordtype">void</span> *context, <a class="code" href="uclean_8h.html#af125d56147c708c2d8ecc5327449c41d" title="An opaque pointer type that represents an ICU mutex.">UMTX</a> *mutex); <a name="l00144"></a>00144 <a name="l00145"></a>00145 <a name="l00165"></a>00165 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00166"></a>00166 <a class="code" href="uclean_8h.html#ad286bdc5cbaf91e6b6e8f9c565455ec0" title="Set the functions that ICU will use for mutex operations Use of this function is...">u_setMutexFunctions</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, <a class="code" href="uclean_8h.html#a302ac3ea859a593dea50f9a1b06ce5b1" title="Function Pointer type for a user supplied mutex initialization function.">UMtxInitFn</a> *init, <a class="code" href="uclean_8h.html#a67a2314f542b9f495ef0b2ac1cfd5192" title="Function Pointer type for a user supplied mutex functions.">UMtxFn</a> *destroy, <a class="code" href="uclean_8h.html#a67a2314f542b9f495ef0b2ac1cfd5192" title="Function Pointer type for a user supplied mutex functions.">UMtxFn</a> *lock, <a class="code" href="uclean_8h.html#a67a2314f542b9f495ef0b2ac1cfd5192" title="Function Pointer type for a user supplied mutex functions.">UMtxFn</a> *unlock, <a name="l00167"></a>00167 <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> *status); <a name="l00168"></a>00168 <a name="l00169"></a>00169 <a name="l00178"></a><a class="code" href="uclean_8h.html#a21713ef0c8987c243f315dab6db8e2b8">00178</a> <span class="keyword">typedef</span> int32_t <a class="code" href="utypes_8h.html#a1fae478cb5a46c7e4a0673d267626696" title="Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function...">U_CALLCONV</a> <a class="code" href="uclean_8h.html#a21713ef0c8987c243f315dab6db8e2b8" title="Pointer type for a user supplied atomic increment or decrement function.">UMtxAtomicFn</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, int32_t *p); <a name="l00179"></a>00179 <a name="l00195"></a>00195 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00196"></a>00196 <a class="code" href="uclean_8h.html#a677b75b566af2a41202e255262ff38c3" title="Set the functions that ICU will use for atomic increment and decrement of int32_t...">u_setAtomicIncDecFunctions</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, <a class="code" href="uclean_8h.html#a21713ef0c8987c243f315dab6db8e2b8" title="Pointer type for a user supplied atomic increment or decrement function.">UMtxAtomicFn</a> *inc, <a class="code" href="uclean_8h.html#a21713ef0c8987c243f315dab6db8e2b8" title="Pointer type for a user supplied atomic increment or decrement function.">UMtxAtomicFn</a> *dec, <a name="l00197"></a>00197 <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> *status); <a name="l00198"></a>00198 <a name="l00199"></a>00199 <a name="l00200"></a>00200 <a name="l00209"></a><a class="code" href="uclean_8h.html#a7a7b058f29daf7fcac9a5c27584b1710">00209</a> <span class="keyword">typedef</span> <span class="keywordtype">void</span> *<a class="code" href="utypes_8h.html#a1fae478cb5a46c7e4a0673d267626696" title="Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function...">U_CALLCONV</a> <a class="code" href="uclean_8h.html#a7a7b058f29daf7fcac9a5c27584b1710" title="Pointer type for a user supplied memory allocation function.">UMemAllocFn</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, <span class="keywordtype">size_t</span> size); <a name="l00218"></a><a class="code" href="uclean_8h.html#a1b6b46b156cc0874de4c1f9ae202e6e7">00218</a> <span class="keyword">typedef</span> <span class="keywordtype">void</span> *<a class="code" href="utypes_8h.html#a1fae478cb5a46c7e4a0673d267626696" title="Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function...">U_CALLCONV</a> <a class="code" href="uclean_8h.html#a1b6b46b156cc0874de4c1f9ae202e6e7" title="Pointer type for a user supplied memory re-allocation function.">UMemReallocFn</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, <span class="keywordtype">void</span> *mem, <span class="keywordtype">size_t</span> size); <a name="l00229"></a><a class="code" href="uclean_8h.html#a0ef0908b72449d65c915e6c3d173886a">00229</a> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="utypes_8h.html#a1fae478cb5a46c7e4a0673d267626696" title="Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function...">U_CALLCONV</a> <a class="code" href="uclean_8h.html#a0ef0908b72449d65c915e6c3d173886a" title="Pointer type for a user supplied memory free function.">UMemFreeFn</a> (<span class="keyword">const</span> <span class="keywordtype">void</span> *context, <span class="keywordtype">void</span> *mem); <a name="l00230"></a>00230 <a name="l00247"></a>00247 <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <a name="l00248"></a>00248 <a class="code" href="uclean_8h.html#a5dea766c5e726833400dc0ee24a2bc6a" title="Set the functions that ICU will use for memory allocation.">u_setMemoryFunctions</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, <a class="code" href="uclean_8h.html#a7a7b058f29daf7fcac9a5c27584b1710" title="Pointer type for a user supplied memory allocation function.">UMemAllocFn</a> *a, <a class="code" href="uclean_8h.html#a1b6b46b156cc0874de4c1f9ae202e6e7" title="Pointer type for a user supplied memory re-allocation function.">UMemReallocFn</a> *r, <a class="code" href="uclean_8h.html#a0ef0908b72449d65c915e6c3d173886a" title="Pointer type for a user supplied memory free function.">UMemFreeFn</a> *f, <a name="l00249"></a>00249 <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> *status); <a name="l00250"></a>00250 <a name="l00251"></a>00251 <span class="preprocessor">#endif</span> </pre></div></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>