<!-- 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: utrace.h File Reference</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.1 -->
<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>
</div>
<div class="contents">
<h1>utrace.h File Reference</h1>
<p>C API: Definitions for ICU tracing/logging.
<a href="#_details">More...</a></p>
<code>#include <stdarg.h></code><br/>
<code>#include "<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>"</code><br/>
<p><a href="utrace_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void </td><td class="memItemRight" valign="bottom"><a class="el" href="utrace_8h.html#a57431e5b7de5217371b6b269039d8960">UTraceEntry</a> (const void *context, int32_t fnNumber)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Type signature for the trace function to be called when entering a function. <a href="#a57431e5b7de5217371b6b269039d8960"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void </td><td class="memItemRight" valign="bottom"><a class="el" href="utrace_8h.html#ac819bbfb23657b4a4c465634a0dc0586">UTraceExit</a> (const void *context, int32_t fnNumber, const char *fmt, va_list args)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Type signature for the trace function to be called when exiting from a function. <a href="#ac819bbfb23657b4a4c465634a0dc0586"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void </td><td class="memItemRight" valign="bottom"><a class="el" href="utrace_8h.html#a22a4d10cb4754a7d3178dc55eb61842f">UTraceData</a> (const void *context, int32_t fnNumber, int32_t level, const char *fmt, va_list args)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Type signature for the trace function to be called from within an ICU function to display data or messages. <a href="#a22a4d10cb4754a7d3178dc55eb61842f"></a><br/></td></tr>
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="utrace_8h.html#a87213b0396d0aa046bd9116e89152079">UTraceLevel</a> { <br/>
<a class="el" href="utrace_8h.html#a87213b0396d0aa046bd9116e89152079ad73020624fba9734da1067a92799a7fd">UTRACE_OFF</a> = -1,
<a class="el" href="utrace_8h.html#a87213b0396d0aa046bd9116e89152079a8e9415b7ad8550fa3d9dcc196f88fe98">UTRACE_ERROR</a> = 0,
<a class="el" href="utrace_8h.html#a87213b0396d0aa046bd9116e89152079a4329e6d348c1ce278aa5a70d9d678416">UTRACE_WARNING</a> = 3,
<a class="el" href="utrace_8h.html#a87213b0396d0aa046bd9116e89152079acf27fc8d57f1b0bd0a1700abcc48e9ad">UTRACE_OPEN_CLOSE</a> = 5,
<br/>
<a class="el" href="utrace_8h.html#a87213b0396d0aa046bd9116e89152079ae88684e6ac3d6f889b5d1603395c6bf1">UTRACE_INFO</a> = 7,
<a class="el" href="utrace_8h.html#a87213b0396d0aa046bd9116e89152079af0102c5618b566755d3d0315aeb18ff4">UTRACE_VERBOSE</a> = 9
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Trace severity levels. </p>
<a href="utrace_8h.html#a87213b0396d0aa046bd9116e89152079">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="utrace_8h.html#a6076ad13223437bd15a3266791905308">UTraceFunctionNumber</a> { <br/>
<b>UTRACE_FUNCTION_START</b> = 0,
<b>UTRACE_U_INIT</b> = UTRACE_FUNCTION_START,
<b>UTRACE_U_CLEANUP</b>,
<b>UTRACE_FUNCTION_LIMIT</b>,
<br/>
<b>UTRACE_CONVERSION_START</b> = 0x1000,
<b>UTRACE_UCNV_OPEN</b> = UTRACE_CONVERSION_START,
<b>UTRACE_UCNV_OPEN_PACKAGE</b>,
<b>UTRACE_UCNV_OPEN_ALGORITHMIC</b>,
<br/>
<b>UTRACE_UCNV_CLONE</b>,
<b>UTRACE_UCNV_CLOSE</b>,
<b>UTRACE_UCNV_FLUSH_CACHE</b>,
<b>UTRACE_UCNV_LOAD</b>,
<br/>
<b>UTRACE_UCNV_UNLOAD</b>,
<b>UTRACE_CONVERSION_LIMIT</b>,
<b>UTRACE_COLLATION_START</b> = 0x2000,
<b>UTRACE_UCOL_OPEN</b> = UTRACE_COLLATION_START,
<br/>
<b>UTRACE_UCOL_CLOSE</b>,
<b>UTRACE_UCOL_STRCOLL</b>,
<b>UTRACE_UCOL_GET_SORTKEY</b>,
<b>UTRACE_UCOL_GETLOCALE</b>,
<br/>
<b>UTRACE_UCOL_NEXTSORTKEYPART</b>,
<b>UTRACE_UCOL_STRCOLLITER</b>,
<b>UTRACE_UCOL_OPEN_FROM_SHORT_STRING</b>,
<b>UTRACE_COLLATION_LIMIT</b>
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>These are the ICU functions that will be traced when tracing is enabled. </p>
<a href="utrace_8h.html#a6076ad13223437bd15a3266791905308">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="utrace_8h.html#aeb56de5759104ee6379b8144afbe6d01">utrace_setLevel</a> (int32_t traceLevel)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Setter for the trace level. <a href="#aeb56de5759104ee6379b8144afbe6d01"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="utrace_8h.html#afc368ae253afd3d22821a868765e54e5">utrace_getLevel</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Getter for the trace level. <a href="#afc368ae253afd3d22821a868765e54e5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="utrace_8h.html#aa87ea156afa4807f0a3db73d85c66551">utrace_setFunctions</a> (const void *context, <a class="el" href="utrace_8h.html#a57431e5b7de5217371b6b269039d8960">UTraceEntry</a> *e, <a class="el" href="utrace_8h.html#ac819bbfb23657b4a4c465634a0dc0586">UTraceExit</a> *x, <a class="el" href="utrace_8h.html#a22a4d10cb4754a7d3178dc55eb61842f">UTraceData</a> *d)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set ICU Tracing functions. <a href="#aa87ea156afa4807f0a3db73d85c66551"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="utrace_8h.html#a15c3bee50058d10cdaa1ecc87cd18bae">utrace_getFunctions</a> (const void **context, <a class="el" href="utrace_8h.html#a57431e5b7de5217371b6b269039d8960">UTraceEntry</a> **e, <a class="el" href="utrace_8h.html#ac819bbfb23657b4a4c465634a0dc0586">UTraceExit</a> **x, <a class="el" href="utrace_8h.html#a22a4d10cb4754a7d3178dc55eb61842f">UTraceData</a> **d)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the currently installed ICU tracing functions. <a href="#a15c3bee50058d10cdaa1ecc87cd18bae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="utrace_8h.html#abcd5b54f8b10a9a319abf195711c717a">utrace_vformat</a> (char *outBuf, int32_t capacity, int32_t indent, const char *fmt, va_list args)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Trace output Formatter. <a href="#abcd5b54f8b10a9a319abf195711c717a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="utrace_8h.html#ab1c46bbcc3ae5dda6eeb89ba0b04eab5">utrace_format</a> (char *outBuf, int32_t capacity, int32_t indent, const char *fmt,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Trace output Formatter. <a href="#ab1c46bbcc3ae5dda6eeb89ba0b04eab5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="utrace_8h.html#a888fae89e1bae1080cca94e4284bfeea">utrace_functionName</a> (int32_t fnNumber)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of a function from its trace function number. <a href="#a888fae89e1bae1080cca94e4284bfeea"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>C API: Definitions for ICU tracing/logging. </p>
<p>This provides API for debugging the internals of ICU without the use of a traditional debugger.</p>
<p>By default, tracing is disabled in ICU. If you need to debug ICU with tracing, please compile ICU with the --enable-tracing configure option. </p>
<p>Definition in file <a class="el" href="utrace_8h_source.html">utrace.h</a>.</p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a22a4d10cb4754a7d3178dc55eb61842f"></a><!-- doxytag: member="utrace.h::UTraceData" ref="a22a4d10cb4754a7d3178dc55eb61842f" args="(const void *context, int32_t fnNumber, int32_t level, const char *fmt, va_list args)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void <a class="el" href="utrace_8h.html#a22a4d10cb4754a7d3178dc55eb61842f">UTraceData</a>(const void *context, int32_t fnNumber, int32_t level, const char *fmt, va_list args)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Type signature for the trace function to be called from within an ICU function to display data or messages. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>value supplied at the time the trace functions are set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fnNumber</em> </td><td>Enum value indicating the ICU function being exited. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>level</em> </td><td>The current tracing level </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fmt</em> </td><td>A format string describing the tracing data that is supplied as variable args </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>The data being traced, passed as variable args. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002085">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
<p>Definition at line <a class="el" href="utrace_8h_source.html#l00148">148</a> of file <a class="el" href="utrace_8h_source.html">utrace.h</a>.</p>
</div>
</div>
<a class="anchor" id="a57431e5b7de5217371b6b269039d8960"></a><!-- doxytag: member="utrace.h::UTraceEntry" ref="a57431e5b7de5217371b6b269039d8960" args="(const void *context, int32_t fnNumber)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void <a class="el" href="utrace_8h.html#a57431e5b7de5217371b6b269039d8960">UTraceEntry</a>(const void *context, int32_t fnNumber)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Type signature for the trace function to be called when entering a function. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>value supplied at the time the trace functions are set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fnNumber</em> </td><td>Enum value indicating the ICU function being entered. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002083">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
<p>Definition at line <a class="el" href="utrace_8h_source.html#l00117">117</a> of file <a class="el" href="utrace_8h_source.html">utrace.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac819bbfb23657b4a4c465634a0dc0586"></a><!-- doxytag: member="utrace.h::UTraceExit" ref="ac819bbfb23657b4a4c465634a0dc0586" args="(const void *context, int32_t fnNumber, const char *fmt, va_list args)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void <a class="el" href="utrace_8h.html#ac819bbfb23657b4a4c465634a0dc0586">UTraceExit</a>(const void *context, int32_t fnNumber, const char *fmt, va_list args)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Type signature for the trace function to be called when exiting from a function. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>value supplied at the time the trace functions are set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fnNumber</em> </td><td>Enum value indicating the ICU function being exited. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fmt</em> </td><td>A formatting string that describes the number and types of arguments included with the variable args. The fmt string has the same form as the utrace_vformat format string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>A variable arguments list. Contents are described by the fmt parameter. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="utrace_8h.html#abcd5b54f8b10a9a319abf195711c717a" title="Trace output Formatter.">utrace_vformat</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002084">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
<p>Definition at line <a class="el" href="utrace_8h_source.html#l00133">133</a> of file <a class="el" href="utrace_8h_source.html">utrace.h</a>.</p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a6076ad13223437bd15a3266791905308"></a><!-- doxytag: member="utrace.h::UTraceFunctionNumber" ref="a6076ad13223437bd15a3266791905308" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="utrace_8h.html#a6076ad13223437bd15a3266791905308">UTraceFunctionNumber</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>These are the ICU functions that will be traced when tracing is enabled. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002080">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
<p>Definition at line <a class="el" href="utrace_8h_source.html#l00063">63</a> of file <a class="el" href="utrace_8h_source.html">utrace.h</a>.</p>
</div>
</div>
<a class="anchor" id="a87213b0396d0aa046bd9116e89152079"></a><!-- doxytag: member="utrace.h::UTraceLevel" ref="a87213b0396d0aa046bd9116e89152079" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="utrace_8h.html#a87213b0396d0aa046bd9116e89152079">UTraceLevel</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Trace severity levels. </p>
<p>Higher levels increase the verbosity of the trace output. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="utrace_8h.html#aeb56de5759104ee6379b8144afbe6d01" title="Setter for the trace level.">utrace_setLevel</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002079">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a87213b0396d0aa046bd9116e89152079ad73020624fba9734da1067a92799a7fd"></a><!-- doxytag: member="UTRACE_OFF" ref="a87213b0396d0aa046bd9116e89152079ad73020624fba9734da1067a92799a7fd" args="" -->UTRACE_OFF</em> </td><td>
<p>Disable all tracing. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002091">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a87213b0396d0aa046bd9116e89152079a8e9415b7ad8550fa3d9dcc196f88fe98"></a><!-- doxytag: member="UTRACE_ERROR" ref="a87213b0396d0aa046bd9116e89152079a8e9415b7ad8550fa3d9dcc196f88fe98" args="" -->UTRACE_ERROR</em> </td><td>
<p>Trace error conditions only. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002092">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a87213b0396d0aa046bd9116e89152079a4329e6d348c1ce278aa5a70d9d678416"></a><!-- doxytag: member="UTRACE_WARNING" ref="a87213b0396d0aa046bd9116e89152079a4329e6d348c1ce278aa5a70d9d678416" args="" -->UTRACE_WARNING</em> </td><td>
<p>Trace errors and warnings. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002093">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a87213b0396d0aa046bd9116e89152079acf27fc8d57f1b0bd0a1700abcc48e9ad"></a><!-- doxytag: member="UTRACE_OPEN_CLOSE" ref="a87213b0396d0aa046bd9116e89152079acf27fc8d57f1b0bd0a1700abcc48e9ad" args="" -->UTRACE_OPEN_CLOSE</em> </td><td>
<p>Trace opens and closes of ICU services. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002094">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a87213b0396d0aa046bd9116e89152079ae88684e6ac3d6f889b5d1603395c6bf1"></a><!-- doxytag: member="UTRACE_INFO" ref="a87213b0396d0aa046bd9116e89152079ae88684e6ac3d6f889b5d1603395c6bf1" args="" -->UTRACE_INFO</em> </td><td>
<p>Trace an intermediate number of ICU operations. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002095">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a87213b0396d0aa046bd9116e89152079af0102c5618b566755d3d0315aeb18ff4"></a><!-- doxytag: member="UTRACE_VERBOSE" ref="a87213b0396d0aa046bd9116e89152079af0102c5618b566755d3d0315aeb18ff4" args="" -->UTRACE_VERBOSE</em> </td><td>
<p>Trace the maximum number of ICU operations. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002096">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="utrace_8h_source.html#l00044">44</a> of file <a class="el" href="utrace_8h_source.html">utrace.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ab1c46bbcc3ae5dda6eeb89ba0b04eab5"></a><!-- doxytag: member="utrace.h::utrace_format" ref="ab1c46bbcc3ae5dda6eeb89ba0b04eab5" args="(char *outBuf, int32_t capacity, int32_t indent, const char *fmt,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t utrace_format </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>outBuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>capacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>indent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Trace output Formatter. </p>
<p>An application's UTraceData tracing functions may call this function to format any additional trace data, beyond that provided by default, in human readable form with the same formatting conventions used by <a class="el" href="utrace_8h.html#abcd5b54f8b10a9a319abf195711c717a" title="Trace output Formatter.">utrace_vformat()</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>outBuf</em> </td><td>pointer to a buffer to receive the formatted output. Output will be nul terminated if there is space in the buffer - if the length of the requested output < the output buffer size. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>capacity</em> </td><td>Length of the output buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>indent</em> </td><td>Number of spaces to indent the output. Intended to allow data displayed from nested functions to be indented for readability. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fmt</em> </td><td><a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> specification for the data to output </td></tr>
<tr><td valign="top"></td><td valign="top"><em>...</em> </td><td>Data to be formatted. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Length of formatted output, including the terminating NUL. If buffer capacity is insufficient, the required capacity is returned. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002089">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a888fae89e1bae1080cca94e4284bfeea"></a><!-- doxytag: member="utrace.h::utrace_functionName" ref="a888fae89e1bae1080cca94e4284bfeea" args="(int32_t fnNumber)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* utrace_functionName </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>fnNumber</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the name of a function from its trace function number. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fnNumber</em> </td><td>The trace number for an ICU function. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The name string for the function.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="utrace_8h.html#a6076ad13223437bd15a3266791905308" title="These are the ICU functions that will be traced when tracing is enabled.">UTraceFunctionNumber</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002090">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a15c3bee50058d10cdaa1ecc87cd18bae"></a><!-- doxytag: member="utrace.h::utrace_getFunctions" ref="a15c3bee50058d10cdaa1ecc87cd18bae" args="(const void **context, UTraceEntry **e, UTraceExit **x, UTraceData **d)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void utrace_getFunctions </td>
<td>(</td>
<td class="paramtype">const void ** </td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utrace_8h.html#a57431e5b7de5217371b6b269039d8960">UTraceEntry</a> ** </td>
<td class="paramname"> <em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utrace_8h.html#ac819bbfb23657b4a4c465634a0dc0586">UTraceExit</a> ** </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utrace_8h.html#a22a4d10cb4754a7d3178dc55eb61842f">UTraceData</a> ** </td>
<td class="paramname"> <em>d</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the currently installed ICU tracing functions. </p>
<p>Note that a null function pointer will be returned if no trace function has been set.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>The currently installed tracing context. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>e</em> </td><td>The currently installed UTraceEntry function. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>The currently installed UTraceExit function. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>The currently installed UTraceData function. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002087">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="afc368ae253afd3d22821a868765e54e5"></a><!-- doxytag: member="utrace.h::utrace_getLevel" ref="afc368ae253afd3d22821a868765e54e5" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t utrace_getLevel </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Getter for the trace level. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The UTraceLevel value being used by ICU. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002082">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="aa87ea156afa4807f0a3db73d85c66551"></a><!-- doxytag: member="utrace.h::utrace_setFunctions" ref="aa87ea156afa4807f0a3db73d85c66551" args="(const void *context, UTraceEntry *e, UTraceExit *x, UTraceData *d)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void utrace_setFunctions </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utrace_8h.html#a57431e5b7de5217371b6b269039d8960">UTraceEntry</a> * </td>
<td class="paramname"> <em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utrace_8h.html#ac819bbfb23657b4a4c465634a0dc0586">UTraceExit</a> * </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utrace_8h.html#a22a4d10cb4754a7d3178dc55eb61842f">UTraceData</a> * </td>
<td class="paramname"> <em>d</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set ICU Tracing functions. </p>
<p>Installs application-provided tracing functions into ICU. After doing this, subsequent ICU operations will call back to the installed functions, providing a trace of the use of ICU. Passing a NULL pointer for a tracing function is allowed, and inhibits tracing action at points where that function would be called. </p>
<p>Tracing and Threads: Tracing functions are global to a process, and will be called in response to ICU operations performed by any thread. If tracing of an individual thread is desired, the tracing functions must themselves filter by checking that the current thread is the desired thread.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>an uninterpretted pointer. Whatever is passed in here will in turn be passed to each of the tracing functions UTraceEntry, UTraceExit and UTraceData. ICU does not use or alter this pointer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>e</em> </td><td>Callback function to be called on entry to a a traced ICU function. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>Callback function to be called on exit from a traced ICU function. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>Callback function to be called from within a traced ICU function, for the purpose of providing data to the trace.</td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002086">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="aeb56de5759104ee6379b8144afbe6d01"></a><!-- doxytag: member="utrace.h::utrace_setLevel" ref="aeb56de5759104ee6379b8144afbe6d01" args="(int32_t traceLevel)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void utrace_setLevel </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>traceLevel</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Setter for the trace level. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>traceLevel</em> </td><td>A UTraceLevel value. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002081">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="abcd5b54f8b10a9a319abf195711c717a"></a><!-- doxytag: member="utrace.h::utrace_vformat" ref="abcd5b54f8b10a9a319abf195711c717a" args="(char *outBuf, int32_t capacity, int32_t indent, const char *fmt, va_list args)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t utrace_vformat </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>outBuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>capacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>indent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list </td>
<td class="paramname"> <em>args</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Trace output Formatter. </p>
<p>An application's UTraceData tracing functions may call back to this function to format the trace output in a human readable form. Note that a UTraceData function may choose to not format the data; it could, for example, save it in in the raw form it was received (more compact), leaving formatting for a later trace analyis tool. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>outBuf</em> </td><td>pointer to a buffer to receive the formatted output. Output will be nul terminated if there is space in the buffer - if the length of the requested output < the output buffer size. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>capacity</em> </td><td>Length of the output buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>indent</em> </td><td>Number of spaces to indent the output. Intended to allow data displayed from nested functions to be indented for readability. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fmt</em> </td><td><a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> specification for the data to output </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>Data to be formatted. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Length of formatted output, including the terminating NUL. If buffer capacity is insufficient, the required capacity is returned. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002088">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</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 size="1"/><address style="text-align: right;"><small>Generated on 16 Mar 2010 for ICU 4.4 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
f51238514e2abe817779ad2fe01b0759
>
files
>
797
