<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>ICU 52.1: uclean.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">ICU 52.1  <span id="projectnumber">52.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.1.2 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <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="namespaces.html"><span>Namespaces</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> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_bdd9a5d540de89e9fe90efdfc6973a4f.html">common</a></li><li class="navelem"><a class="el" href="dir_f59c6450ff718ff1b085cfd1c36acbd7.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">uclean.h</div> </div> </div><!--header--> <div class="contents"> <a href="uclean_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">******************************************************************************</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">* Copyright (C) 2001-2013, International Business Machines</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">* Corporation and others. All Rights Reserved.</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">******************************************************************************</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* file name: uclean.h</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">* encoding: US-ASCII</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">* tab size: 8 (not used)</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">* indentation:4</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">*</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* created on: 2001July05</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">* created by: George Rhoten</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">*/</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef __UCLEAN_H__</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor"></span><span class="preprocessor">#define __UCLEAN_H__</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <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></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <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> U_EXPORT2 </div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <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 C++ compilers...">UErrorCode</a> *status);</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#ifndef U_HIDE_SYSTEM_API</span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <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> U_EXPORT2 </div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <a class="code" href="uclean_8h.html#a93f27d0ddc7c196a1da864763f2d8920" title="Clean up the system resources, such as allocated memory or open files, used in all ICU libraries...">u_cleanup</a>(<span class="keywordtype">void</span>);</div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div> <div class="line"><a name="l00111"></a><span class="lineno"><a class="code" href="uclean_8h.html#a7a7b058f29daf7fcac9a5c27584b1710"> 111</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> *<a class="code" href="platform_8h.html#a1fae478cb5a46c7e4a0673d267626696" title="Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to ma...">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);</div> <div class="line"><a name="l00120"></a><span class="lineno"><a class="code" href="uclean_8h.html#a1b6b46b156cc0874de4c1f9ae202e6e7"> 120</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> *<a class="code" href="platform_8h.html#a1fae478cb5a46c7e4a0673d267626696" title="Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to ma...">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);</div> <div class="line"><a name="l00131"></a><span class="lineno"><a class="code" href="uclean_8h.html#a0ef0908b72449d65c915e6c3d173886a"> 131</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#a1fae478cb5a46c7e4a0673d267626696" title="Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to ma...">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);</div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <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> U_EXPORT2 </div> <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <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, </div> <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all C++ compilers...">UErrorCode</a> *status);</div> <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div> <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div> <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">/*********************************************************************************</span></div> <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> *</span></div> <div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * Deprecated Functions</span></div> <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> *</span></div> <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * The following functions for user supplied mutexes are no longer supported.</span></div> <div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * Any attempt to use them will return a U_UNSUPPORTED_ERROR.</span></div> <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> *</span></div> <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> **********************************************************************************/</span></div> <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div> <div class="line"><a name="l00170"></a><span class="lineno"><a class="code" href="uclean_8h.html#af125d56147c708c2d8ecc5327449c41d"> 170</a></span> <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>;</div> <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div> <div class="line"><a name="l00188"></a><span class="lineno"><a class="code" href="uclean_8h.html#a302ac3ea859a593dea50f9a1b06ce5b1"> 188</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#a1fae478cb5a46c7e4a0673d267626696" title="Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to ma...">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 C++ compilers...">UErrorCode</a>* status);</div> <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div> <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> </div> <div class="line"><a name="l00200"></a><span class="lineno"><a class="code" href="uclean_8h.html#a67a2314f542b9f495ef0b2ac1cfd5192"> 200</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#a1fae478cb5a46c7e4a0673d267626696" title="Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to ma...">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);</div> <div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div> <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> </div> <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <a class="code" href="umachine_8h.html#a15493bbbc3793fa60b33cad4955430a0" title="This is used to declare a function as a deprecated public ICU C API.">U_DEPRECATED</a> <span class="keywordtype">void</span> U_EXPORT2 </div> <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <a class="code" href="uclean_8h.html#ad286bdc5cbaf91e6b6e8f9c565455ec0" title="Set the functions that ICU will use for mutex operations Use of this function is optional; by default...">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,</div> <div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all C++ compilers...">UErrorCode</a> *status);</div> <div class="line"><a name="l00223"></a><span class="lineno"> 223</span> </div> <div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div> <div class="line"><a name="l00233"></a><span class="lineno"><a class="code" href="uclean_8h.html#a21713ef0c8987c243f315dab6db8e2b8"> 233</a></span> <span class="keyword">typedef</span> int32_t <a class="code" href="platform_8h.html#a1fae478cb5a46c7e4a0673d267626696" title="Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to ma...">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);</div> <div class="line"><a name="l00234"></a><span class="lineno"> 234</span> </div> <div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <a class="code" href="umachine_8h.html#a15493bbbc3793fa60b33cad4955430a0" title="This is used to declare a function as a deprecated public ICU C API.">U_DEPRECATED</a> <span class="keywordtype">void</span> U_EXPORT2 </div> <div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <a class="code" href="uclean_8h.html#a677b75b566af2a41202e255262ff38c3" title="Set the functions that ICU will use for atomic increment and decrement of int32_t values...">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,</div> <div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all C++ compilers...">UErrorCode</a> *status);</div> <div class="line"><a name="l00253"></a><span class="lineno"> 253</span> </div> <div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="preprocessor">#endif </span><span class="comment">/* U_HIDE_SYSTEM_API */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="preprocessor">#endif</span></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Oct 4 2013 14:10:21 for ICU 52.1 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.1.2 </small></address> </body> </html>