<!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: errorcode.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">errorcode.h</div> </div> </div><!--header--> <div class="contents"> <a href="errorcode_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">*</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">* Copyright (C) 2009-2011, International Business Machines</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">* Corporation and others. All Rights Reserved.</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">*</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">*******************************************************************************</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">* file name: errorcode.h</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">* encoding: US-ASCII</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">* tab size: 8 (not used)</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* indentation:4</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">*</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">* created on: 2009mar10</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">* created by: Markus W. Scherer</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">*/</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef __ERRORCODE_H__</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __ERRORCODE_H__</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</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="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="uobject_8h.html" title="C++ API: Common ICU base class UObject.">unicode/uobject.h</a>"</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <a class="code" href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b" title="This is used to begin a declaration of a public ICU C++ API.">U_NAMESPACE_BEGIN</a></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> <div class="line"><a name="l00079"></a><span class="lineno"><a class="code" href="classicu_1_1ErrorCode.html"> 79</a></span> <span class="keyword">class </span><a class="code" href="utypes_8h.html#a559955ec3bc692657c5d8b1c6de8e334" title="Set to export library symbols from inside the common library, and to import them from outside...">U_COMMON_API</a> <a class="code" href="classicu_1_1ErrorCode.html" title="Wrapper class for UErrorCode, with conversion operators for direct use in ICU C and C++ APIs...">ErrorCode</a>: <span class="keyword">public</span> <a class="code" href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class.">UMemory</a> {</div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00085"></a><span class="lineno"><a class="code" href="classicu_1_1ErrorCode.html#ac675f8556eb05f4a6b3edc6ecc69a520"> 85</a></span>  <a class="code" href="classicu_1_1ErrorCode.html#ac675f8556eb05f4a6b3edc6ecc69a520" title="Default constructor.">ErrorCode</a>() : errorCode(<a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78caa43dbfc9499c5f911d04e1a0ca3bf6f9" title="No error, no warning.">U_ZERO_ERROR</a>) {}</div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">virtual</span> ~<a class="code" href="classicu_1_1ErrorCode.html" title="Wrapper class for UErrorCode, with conversion operators for direct use in ICU C and C++ APIs...">ErrorCode</a>();</div> <div class="line"><a name="l00089"></a><span class="lineno"><a class="code" href="classicu_1_1ErrorCode.html#ac25c72b1c6791252b3dfbba031a28088"> 89</a></span>  <span class="keyword">operator</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> & () { <span class="keywordflow">return</span> errorCode; }</div> <div class="line"><a name="l00091"></a><span class="lineno"><a class="code" href="classicu_1_1ErrorCode.html#ae546113fa2d0a19c41dcf9a1347c6853"> 91</a></span>  <span class="keyword">operator</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> * () { <span class="keywordflow">return</span> &errorCode; }</div> <div class="line"><a name="l00093"></a><span class="lineno"><a class="code" href="classicu_1_1ErrorCode.html#acf301523080d1204eccc01105eb325bb"> 93</a></span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> <a class="code" href="classicu_1_1ErrorCode.html#acf301523080d1204eccc01105eb325bb" title="Tests for U_SUCCESS().">isSuccess</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success?">U_SUCCESS</a>(errorCode); }</div> <div class="line"><a name="l00095"></a><span class="lineno"><a class="code" href="classicu_1_1ErrorCode.html#a76f92eccadcb4d884dbb18996ad73a1c"> 95</a></span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> <a class="code" href="classicu_1_1ErrorCode.html#a76f92eccadcb4d884dbb18996ad73a1c" title="Tests for U_FAILURE().">isFailure</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE</a>(errorCode); }</div> <div class="line"><a name="l00097"></a><span class="lineno"><a class="code" href="classicu_1_1ErrorCode.html#a78aaf35396b76c8f90a43655ba0c09b5"> 97</a></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> <span class="keyword">get</span>() <span class="keyword">const</span> { <span class="keywordflow">return</span> errorCode; }</div> <div class="line"><a name="l00099"></a><span class="lineno"><a class="code" href="classicu_1_1ErrorCode.html#aa6429d4ddbb20e212d7c5c095ae8cfd3"> 99</a></span>  <span class="keywordtype">void</span> <span class="keyword">set</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> value) { errorCode=value; }</div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</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> reset();</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">void</span> assertSuccess() <span class="keyword">const</span>;</div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* errorName() <span class="keyword">const</span>;</div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="keyword">protected</span>:</div> <div class="line"><a name="l00125"></a><span class="lineno"><a class="code" href="classicu_1_1ErrorCode.html#a541d64c42a846715e2c345e813672a2b"> 125</a></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> <a class="code" href="classicu_1_1ErrorCode.html#a541d64c42a846715e2c345e813672a2b" title="Internal UErrorCode, accessible to subclasses.">errorCode</a>;</div> <div class="line"><a name="l00132"></a><span class="lineno"><a class="code" href="classicu_1_1ErrorCode.html#acc59cd45476fe2af87563c2c37d7e545"> 132</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classicu_1_1ErrorCode.html#acc59cd45476fe2af87563c2c37d7e545" title="Called by assertSuccess() if isFailure() is true.">handleFailure</a>()<span class="keyword"> const </span>{}</div> <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> };</div> <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div> <div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <a class="code" href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933" title="This is used to end a declaration of a public ICU C++ API.">U_NAMESPACE_END</a></div> <div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div> <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="preprocessor">#endif // __ERRORCODE_H__</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>