Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > f51238514e2abe817779ad2fe01b0759 > files > 96

icu-doc-4.4-2.1mdv2010.2.i586.rpm

<!-- 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: ErrorCode Class 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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;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 class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>ErrorCode Class Reference</h1><!-- doxytag: class="ErrorCode" --><!-- doxytag: inherits="UMemory" -->
<p>Wrapper class for UErrorCode, with conversion operators for direct use in ICU C and C++ APIs.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="errorcode_8h_source.html">errorcode.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ErrorCode:</div>
<div class="dynsection">
 <div class="center">
  <img src="classErrorCode.gif" usemap="#ErrorCode_map" alt=""/>
  <map id="ErrorCode_map" name="ErrorCode_map">
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,72,24"/>
</map>
 </div>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classErrorCode.html#adaf19e1a90d5552207ab98595d90129f">ErrorCode</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#adaf19e1a90d5552207ab98595d90129f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classErrorCode.html#ae2f6100798cd438dabeae33baad364ed">~ErrorCode</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor, does nothing.  <a href="#ae2f6100798cd438dabeae33baad364ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classErrorCode.html#a0a4838eab08afeb636a572cbab1c43bf">operator UErrorCode &amp;</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Conversion operator, returns a reference.  <a href="#a0a4838eab08afeb636a572cbab1c43bf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classErrorCode.html#ad7c50161393172c0e6571857522f70fd">operator UErrorCode *</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Conversion operator, returns a pointer.  <a href="#ad7c50161393172c0e6571857522f70fd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classErrorCode.html#adda7ef44a460f8ec081cad5841189a24">isSuccess</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Tests for <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success?">U_SUCCESS()</a>.  <a href="#adda7ef44a460f8ec081cad5841189a24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classErrorCode.html#a58311f5c65807f1ce64e5458dfda74c0">isFailure</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Tests for <a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE()</a>.  <a href="#a58311f5c65807f1ce64e5458dfda74c0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classErrorCode.html#afe64b6732f4d12d984f8c0756ccfb4ad">get</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the UErrorCode value.  <a href="#afe64b6732f4d12d984f8c0756ccfb4ad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classErrorCode.html#a062be13bd2216ed70ce9844ab6a29441">set</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the UErrorCode value.  <a href="#a062be13bd2216ed70ce9844ab6a29441"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classErrorCode.html#a52f1f0c6687084d980df923ecd76945d">reset</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the UErrorCode value and resets it to U_ZERO_ERROR.  <a href="#a52f1f0c6687084d980df923ecd76945d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classErrorCode.html#a7697311334f1c312276236c62424d413">assertSuccess</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Asserts <a class="el" href="classErrorCode.html#adda7ef44a460f8ec081cad5841189a24" title="Tests for U_SUCCESS().">isSuccess()</a>.  <a href="#a7697311334f1c312276236c62424d413"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classErrorCode.html#a73244a121c08a3e4b4a4d2f51448a6aa">errorName</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a string for the UErrorCode value.  <a href="#a73244a121c08a3e4b4a4d2f51448a6aa"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classErrorCode.html#a0f81ad4f9be3a2f0724934ed2e9d9c63">handleFailure</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called by <a class="el" href="classErrorCode.html#a7697311334f1c312276236c62424d413" title="Asserts isSuccess().">assertSuccess()</a> if <a class="el" href="classErrorCode.html#a58311f5c65807f1ce64e5458dfda74c0" title="Tests for U_FAILURE().">isFailure()</a> is true.  <a href="#a0f81ad4f9be3a2f0724934ed2e9d9c63"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classErrorCode.html#acb34773ffbcba381a3e90e07925bb72f">errorCode</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal UErrorCode, accessible to subclasses.  <a href="#acb34773ffbcba381a3e90e07925bb72f"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Wrapper class for UErrorCode, with conversion operators for direct use in ICU C and C++ APIs. </p>
<p>Intended to be used as a base class, where a subclass overrides the <a class="el" href="classErrorCode.html#a0f81ad4f9be3a2f0724934ed2e9d9c63" title="Called by assertSuccess() if isFailure() is true.">handleFailure()</a> function so that it throws an exception, does an assert(), logs an error, etc. This is not an abstract base class. This class can be used and instantiated by itself, although it will be more useful when subclassed.</p>
<p>Features:</p>
<ul>
<li>The constructor initializes the internal UErrorCode to U_ZERO_ERROR, removing one common source of errors.</li>
<li>Same use in C APIs taking a UErrorCode * (pointer) and C++ taking UErrorCode &amp; (reference) via conversion operators.</li>
<li>Possible automatic checking for success when it goes out of scope.</li>
</ul>
<p>Note: For automatic checking for success in the destructor, a subclass must implement such logic in its own destructor because the base class destructor cannot call a subclass function (like <a class="el" href="classErrorCode.html#a0f81ad4f9be3a2f0724934ed2e9d9c63" title="Called by assertSuccess() if isFailure() is true.">handleFailure()</a>). The <a class="el" href="classErrorCode.html" title="Wrapper class for UErrorCode, with conversion operators for direct use in ICU C and...">ErrorCode</a> base class destructor does nothing.</p>
<p>Note also: While it is possible for a destructor to throw an exception, it is generally unsafe to do so. This means that in a subclass the destructor and the <a class="el" href="classErrorCode.html#a0f81ad4f9be3a2f0724934ed2e9d9c63" title="Called by assertSuccess() if isFailure() is true.">handleFailure()</a> function may need to take different actions.</p>
<p>Sample code: </p>
<div class="fragment"><pre class="fragment">   <span class="keyword">class </span>IcuErrorCode: <span class="keyword">public</span> icu::<a class="code" href="classErrorCode.html" title="Wrapper class for UErrorCode, with conversion operators for direct use in ICU C and...">ErrorCode</a> {
   <span class="keyword">public</span>:
     <span class="keyword">virtual</span> ~IcuErrorCode() {
       <span class="comment">// Safe because our handleFailure() does not throw exceptions.</span>
       <span class="keywordflow">if</span>(<a class="code" href="classErrorCode.html#a58311f5c65807f1ce64e5458dfda74c0" title="Tests for U_FAILURE().">isFailure</a>()) { <a class="code" href="classErrorCode.html#a0f81ad4f9be3a2f0724934ed2e9d9c63" title="Called by assertSuccess() if isFailure() is true.">handleFailure</a>(); }
     }
   <span class="keyword">protected</span>:
     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classErrorCode.html#a0f81ad4f9be3a2f0724934ed2e9d9c63" title="Called by assertSuccess() if isFailure() is true.">handleFailure</a>()<span class="keyword"> const </span>{
       log_failure(<a class="code" href="utypes_8h.html#a89eb455526bb29bf5350ee861d81df92" title="Return a string for a UErrorCode value.">u_errorName</a>(<a class="code" href="classErrorCode.html#acb34773ffbcba381a3e90e07925bb72f" title="Internal UErrorCode, accessible to subclasses.">errorCode</a>));
       exit(<a class="code" href="classErrorCode.html#acb34773ffbcba381a3e90e07925bb72f" title="Internal UErrorCode, accessible to subclasses.">errorCode</a>);
     }
   };
   IcuErrorCode error_code;
   <a class="code" href="ucnv__err_8h.html#a0c2dcfbf71ad577f5285869e1ceb26b1">UConverter</a> *cnv = <a class="code" href="ucnv_8h.html#a485c78d4149165f504effa2287717e41" title="Creates a UConverter object with the name of a coded character set specified as a...">ucnv_open</a>(<span class="stringliteral">&quot;Shift-JIS&quot;</span>, error_code);
   length = <a class="code" href="ucnv_8h.html#a31bd5a5af440108a1a51bb0234ad32ac" title="Convert the Unicode string into a codepage string using an existing UConverter.">ucnv_fromUChars</a>(dest, capacity, src, length, error_code);
   <a class="code" href="ucnv_8h.html#a1718689bf60724fdfa08c51aa0cc5ea0" title="Deletes the unicode converter and releases resources associated with just this instance...">ucnv_close</a>(cnv);
   <span class="comment">// IcuErrorCode destructor checks for success.</span>
</pre></div><dl class="stable"><dt><b><a class="el" href="stable.html#_stable000122">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Definition at line <a class="el" href="errorcode_8h_source.html#l00079">79</a> of file <a class="el" href="errorcode_8h_source.html">errorcode.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="adaf19e1a90d5552207ab98595d90129f"></a><!-- doxytag: member="ErrorCode::ErrorCode" ref="adaf19e1a90d5552207ab98595d90129f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ErrorCode::ErrorCode </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Default constructor. </p>
<p>Initializes its UErrorCode to U_ZERO_ERROR. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000123">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Definition at line <a class="el" href="errorcode_8h_source.html#l00085">85</a> of file <a class="el" href="errorcode_8h_source.html">errorcode.h</a>.</p>

</div>
</div>
<a class="anchor" id="ae2f6100798cd438dabeae33baad364ed"></a><!-- doxytag: member="ErrorCode::~ErrorCode" ref="ae2f6100798cd438dabeae33baad364ed" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual ErrorCode::~ErrorCode </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Destructor, does nothing. </p>
<p>See class documentation for details. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000124">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Definition at line <a class="el" href="errorcode_8h_source.html#l00087">87</a> of file <a class="el" href="errorcode_8h_source.html">errorcode.h</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7697311334f1c312276236c62424d413"></a><!-- doxytag: member="ErrorCode::assertSuccess" ref="a7697311334f1c312276236c62424d413" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ErrorCode::assertSuccess </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Asserts <a class="el" href="classErrorCode.html#adda7ef44a460f8ec081cad5841189a24" title="Tests for U_SUCCESS().">isSuccess()</a>. </p>
<p>In other words, this method checks for a failure code, and the base class handles it like this: </p>
<div class="fragment"><pre class="fragment">   <span class="keywordflow">if</span>(<a class="code" href="classErrorCode.html#a58311f5c65807f1ce64e5458dfda74c0" title="Tests for U_FAILURE().">isFailure</a>()) { <a class="code" href="classErrorCode.html#a0f81ad4f9be3a2f0724934ed2e9d9c63" title="Called by assertSuccess() if isFailure() is true.">handleFailure</a>(); }
</pre></div> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000005">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.4 </dd></dl>

</div>
</div>
<a class="anchor" id="a73244a121c08a3e4b4a4d2f51448a6aa"></a><!-- doxytag: member="ErrorCode::errorName" ref="a73244a121c08a3e4b4a4d2f51448a6aa" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* ErrorCode::errorName </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return a string for the UErrorCode value. </p>
<p>The string will be the same as the name of the error code constant in the UErrorCode enum. </p>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000006">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.4 </dd></dl>

</div>
</div>
<a class="anchor" id="afe64b6732f4d12d984f8c0756ccfb4ad"></a><!-- doxytag: member="ErrorCode::get" ref="afe64b6732f4d12d984f8c0756ccfb4ad" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> ErrorCode::get </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the UErrorCode value. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000129">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Definition at line <a class="el" href="errorcode_8h_source.html#l00097">97</a> of file <a class="el" href="errorcode_8h_source.html">errorcode.h</a>.</p>

</div>
</div>
<a class="anchor" id="a0f81ad4f9be3a2f0724934ed2e9d9c63"></a><!-- doxytag: member="ErrorCode::handleFailure" ref="a0f81ad4f9be3a2f0724934ed2e9d9c63" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ErrorCode::handleFailure </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline, protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Called by <a class="el" href="classErrorCode.html#a7697311334f1c312276236c62424d413" title="Asserts isSuccess().">assertSuccess()</a> if <a class="el" href="classErrorCode.html#a58311f5c65807f1ce64e5458dfda74c0" title="Tests for U_FAILURE().">isFailure()</a> is true. </p>
<p>A subclass should override this function to deal with a failure code: Throw an exception, log an error, terminate the program, or similar. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000133">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Definition at line <a class="el" href="errorcode_8h_source.html#l00132">132</a> of file <a class="el" href="errorcode_8h_source.html">errorcode.h</a>.</p>

</div>
</div>
<a class="anchor" id="a58311f5c65807f1ce64e5458dfda74c0"></a><!-- doxytag: member="ErrorCode::isFailure" ref="a58311f5c65807f1ce64e5458dfda74c0" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ErrorCode::isFailure </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Tests for <a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE()</a>. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000128">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Definition at line <a class="el" href="errorcode_8h_source.html#l00095">95</a> of file <a class="el" href="errorcode_8h_source.html">errorcode.h</a>.</p>

<p>References <a class="el" href="utypes_8h_source.html#l00852">U_FAILURE</a>.</p>

</div>
</div>
<a class="anchor" id="adda7ef44a460f8ec081cad5841189a24"></a><!-- doxytag: member="ErrorCode::isSuccess" ref="adda7ef44a460f8ec081cad5841189a24" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ErrorCode::isSuccess </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Tests for <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success?">U_SUCCESS()</a>. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000127">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Definition at line <a class="el" href="errorcode_8h_source.html#l00093">93</a> of file <a class="el" href="errorcode_8h_source.html">errorcode.h</a>.</p>

<p>References <a class="el" href="utypes_8h_source.html#l00847">U_SUCCESS</a>.</p>

</div>
</div>
<a class="anchor" id="a0a4838eab08afeb636a572cbab1c43bf"></a><!-- doxytag: member="ErrorCode::operator UErrorCode &amp;" ref="a0a4838eab08afeb636a572cbab1c43bf" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ErrorCode::operator <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &amp; </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Conversion operator, returns a reference. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000125">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Definition at line <a class="el" href="errorcode_8h_source.html#l00089">89</a> of file <a class="el" href="errorcode_8h_source.html">errorcode.h</a>.</p>

</div>
</div>
<a class="anchor" id="ad7c50161393172c0e6571857522f70fd"></a><!-- doxytag: member="ErrorCode::operator UErrorCode *" ref="ad7c50161393172c0e6571857522f70fd" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ErrorCode::operator <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Conversion operator, returns a pointer. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000126">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Definition at line <a class="el" href="errorcode_8h_source.html#l00091">91</a> of file <a class="el" href="errorcode_8h_source.html">errorcode.h</a>.</p>

</div>
</div>
<a class="anchor" id="a52f1f0c6687084d980df923ecd76945d"></a><!-- doxytag: member="ErrorCode::reset" ref="a52f1f0c6687084d980df923ecd76945d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> ErrorCode::reset </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the UErrorCode value and resets it to U_ZERO_ERROR. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000131">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

</div>
</div>
<a class="anchor" id="a062be13bd2216ed70ce9844ab6a29441"></a><!-- doxytag: member="ErrorCode::set" ref="a062be13bd2216ed70ce9844ab6a29441" args="(UErrorCode value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ErrorCode::set </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a>&nbsp;</td>
          <td class="paramname"> <em>value</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the UErrorCode value. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000130">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Definition at line <a class="el" href="errorcode_8h_source.html#l00099">99</a> of file <a class="el" href="errorcode_8h_source.html">errorcode.h</a>.</p>

</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="acb34773ffbcba381a3e90e07925bb72f"></a><!-- doxytag: member="ErrorCode::errorCode" ref="acb34773ffbcba381a3e90e07925bb72f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> <a class="el" href="classErrorCode.html#acb34773ffbcba381a3e90e07925bb72f">ErrorCode::errorCode</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Internal UErrorCode, accessible to subclasses. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000132">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Definition at line <a class="el" href="errorcode_8h_source.html#l00125">125</a> of file <a class="el" href="errorcode_8h_source.html">errorcode.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="errorcode_8h_source.html">errorcode.h</a></li>
</ul>
</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">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&nbsp;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&nbsp;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&nbsp;</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&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>