XQuilla/docs/dom3-api/classxercesc_1_1DOMError.html
2020-02-17 22:24:47 +01:00

337 lines
20 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla DOM3 API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacexercesc.html">xercesc</a></li><li class="navelem"><a class="el" href="classxercesc_1_1DOMError.html">DOMError</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="classxercesc_1_1DOMError-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">xercesc::DOMError Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classxercesc_1_1DOMError.html" title="DOMError is an interface that describes an error. ">DOMError</a> is an interface that describes an error.
<a href="classxercesc_1_1DOMError.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="DOMError_8hpp_source.html">DOMError.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Public constants</div></td></tr>
<tr class="memitem:a2ee4056c45823760a3d9af523c263255"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMError.html#a2ee4056c45823760a3d9af523c263255">ErrorSeverity</a> { <a class="el" href="classxercesc_1_1DOMError.html#a2ee4056c45823760a3d9af523c263255a942d0ffe98b046da0a71b776dafab0b2">DOM_SEVERITY_WARNING</a> = 1,
<a class="el" href="classxercesc_1_1DOMError.html#a2ee4056c45823760a3d9af523c263255a1da26eaa4eaf7be383afc4279c6518b0">DOM_SEVERITY_ERROR</a> = 2,
<a class="el" href="classxercesc_1_1DOMError.html#a2ee4056c45823760a3d9af523c263255aa482572cbda6d79a807bf9ce4ff87874">DOM_SEVERITY_FATAL_ERROR</a> = 3
}</td></tr>
<tr class="memdesc:a2ee4056c45823760a3d9af523c263255"><td class="mdescLeft">&#160;</td><td class="mdescRight">The severity of the error described by the <code><a class="el" href="classxercesc_1_1DOMError.html" title="DOMError is an interface that describes an error. ">DOMError</a></code>. <a href="classxercesc_1_1DOMError.html#a2ee4056c45823760a3d9af523c263255">More...</a><br/></td></tr>
<tr class="separator:a2ee4056c45823760a3d9af523c263255"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
<tr class="memitem:a8887c14def49d790f176ca19dcac5a1d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMError.html#a8887c14def49d790f176ca19dcac5a1d">~DOMError</a> ()</td></tr>
<tr class="memdesc:a8887c14def49d790f176ca19dcac5a1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a8887c14def49d790f176ca19dcac5a1d">More...</a><br/></td></tr>
<tr class="separator:a8887c14def49d790f176ca19dcac5a1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
<tr class="memitem:ab0f9273c1b622184c7c189189355fe24"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMError.html#a2ee4056c45823760a3d9af523c263255">ErrorSeverity</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMError.html#ab0f9273c1b622184c7c189189355fe24">getSeverity</a> () const =0</td></tr>
<tr class="memdesc:ab0f9273c1b622184c7c189189355fe24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the severity of the error. <a href="#ab0f9273c1b622184c7c189189355fe24">More...</a><br/></td></tr>
<tr class="separator:ab0f9273c1b622184c7c189189355fe24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cd1b6e5bd25f1ea4fc171e47e66b125"><td class="memItemLeft" align="right" valign="top">virtual const XMLCh *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMError.html#a6cd1b6e5bd25f1ea4fc171e47e66b125">getMessage</a> () const =0</td></tr>
<tr class="memdesc:a6cd1b6e5bd25f1ea4fc171e47e66b125"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the message describing the error that occured. <a href="#a6cd1b6e5bd25f1ea4fc171e47e66b125">More...</a><br/></td></tr>
<tr class="separator:a6cd1b6e5bd25f1ea4fc171e47e66b125"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac832f99aea641dfda756497b5be1f899"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMLocator.html">DOMLocator</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMError.html#ac832f99aea641dfda756497b5be1f899">getLocation</a> () const =0</td></tr>
<tr class="memdesc:ac832f99aea641dfda756497b5be1f899"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the location of the error. <a href="#ac832f99aea641dfda756497b5be1f899">More...</a><br/></td></tr>
<tr class="separator:ac832f99aea641dfda756497b5be1f899"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a434ccbd1bdb9fe3f08c044104f3d156a"><td class="memItemLeft" align="right" valign="top">virtual void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMError.html#a434ccbd1bdb9fe3f08c044104f3d156a">getRelatedException</a> () const =0</td></tr>
<tr class="memdesc:a434ccbd1bdb9fe3f08c044104f3d156a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The related platform dependent exception if any. <a href="#a434ccbd1bdb9fe3f08c044104f3d156a">More...</a><br/></td></tr>
<tr class="separator:a434ccbd1bdb9fe3f08c044104f3d156a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06f5236dfdc9368bc18bca5359747bdb"><td class="memItemLeft" align="right" valign="top">virtual const XMLCh *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMError.html#a06f5236dfdc9368bc18bca5359747bdb">getType</a> () const =0</td></tr>
<tr class="memdesc:a06f5236dfdc9368bc18bca5359747bdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <code>XMLCh*</code> indicating which related data is expected in relatedData. <a href="#a06f5236dfdc9368bc18bca5359747bdb">More...</a><br/></td></tr>
<tr class="separator:a06f5236dfdc9368bc18bca5359747bdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96b4685277c7068f246617a2ec516f64"><td class="memItemLeft" align="right" valign="top">virtual void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMError.html#a96b4685277c7068f246617a2ec516f64">getRelatedData</a> () const =0</td></tr>
<tr class="memdesc:a96b4685277c7068f246617a2ec516f64"><td class="mdescLeft">&#160;</td><td class="mdescRight">The related <a class="el" href="classxercesc_1_1DOMError.html#a06f5236dfdc9368bc18bca5359747bdb" title="A XMLCh* indicating which related data is expected in relatedData. ">DOMError::getType</a> dependent data if any. <a href="#a96b4685277c7068f246617a2ec516f64">More...</a><br/></td></tr>
<tr class="separator:a96b4685277c7068f246617a2ec516f64"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
<tr class="memitem:a80ab02454c9a7bb8e26e003b6956b367"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMError.html#a80ab02454c9a7bb8e26e003b6956b367">DOMError</a> ()</td></tr>
<tr class="separator:a80ab02454c9a7bb8e26e003b6956b367"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classxercesc_1_1DOMError.html" title="DOMError is an interface that describes an error. ">DOMError</a> is an interface that describes an error. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classxercesc_1_1DOMErrorHandler.html#a67c9662c66074fa8c026cf08b6039ad3" title="This method is called on the error handler when an error occurs. ">DOMErrorHandler::handleError</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a2ee4056c45823760a3d9af523c263255"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classxercesc_1_1DOMError.html#a2ee4056c45823760a3d9af523c263255">xercesc::DOMError::ErrorSeverity</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The severity of the error described by the <code><a class="el" href="classxercesc_1_1DOMError.html" title="DOMError is an interface that describes an error. ">DOMError</a></code>. </p>
<p><code>DOM_SEVERITY_ERROR:</code> The severity of the error described by the <code><a class="el" href="classxercesc_1_1DOMError.html" title="DOMError is an interface that describes an error. ">DOMError</a></code> is error. A DOM_SEVERITY_ERROR may not cause the processing to stop if the error can be recovered, unless <code><a class="el" href="classxercesc_1_1DOMErrorHandler.html#a67c9662c66074fa8c026cf08b6039ad3" title="This method is called on the error handler when an error occurs. ">DOMErrorHandler::handleError()</a></code> returns false.</p>
<p><code>DOM_SEVERITY_FATAL_ERROR</code> The severity of the error described by the <code><a class="el" href="classxercesc_1_1DOMError.html" title="DOMError is an interface that describes an error. ">DOMError</a></code> is fatal error. A DOM_SEVERITY_FATAL_ERROR will cause the normal processing to stop. The return value of <code><a class="el" href="classxercesc_1_1DOMErrorHandler.html#a67c9662c66074fa8c026cf08b6039ad3" title="This method is called on the error handler when an error occurs. ">DOMErrorHandler::handleError()</a></code> is ignored unless the implementation chooses to continue, in which case the behavior becomes undefined.</p>
<p><code>DOM_SEVERITY_WARNING</code> The severity of the error described by the <code><a class="el" href="classxercesc_1_1DOMError.html" title="DOMError is an interface that describes an error. ">DOMError</a></code> is warning. A DOM_SEVERITY_WARNING will not cause the processing to stop, unless <code><a class="el" href="classxercesc_1_1DOMErrorHandler.html#a67c9662c66074fa8c026cf08b6039ad3" title="This method is called on the error handler when an error occurs. ">DOMErrorHandler::handleError()</a></code> returns false.</p>
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a2ee4056c45823760a3d9af523c263255a942d0ffe98b046da0a71b776dafab0b2"></a>DOM_SEVERITY_WARNING</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a2ee4056c45823760a3d9af523c263255a1da26eaa4eaf7be383afc4279c6518b0"></a>DOM_SEVERITY_ERROR</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a2ee4056c45823760a3d9af523c263255aa482572cbda6d79a807bf9ce4ff87874"></a>DOM_SEVERITY_FATAL_ERROR</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a80ab02454c9a7bb8e26e003b6956b367"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMError::DOMError </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a8887c14def49d790f176ca19dcac5a1d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual xercesc::DOMError::~DOMError </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac832f99aea641dfda756497b5be1f899"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMLocator.html">DOMLocator</a>* xercesc::DOMError::getLocation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the location of the error. </p>
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
</div>
</div>
<a class="anchor" id="a6cd1b6e5bd25f1ea4fc171e47e66b125"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* xercesc::DOMError::getMessage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the message describing the error that occured. </p>
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
</div>
</div>
<a class="anchor" id="a96b4685277c7068f246617a2ec516f64"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void* xercesc::DOMError::getRelatedData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The related <a class="el" href="classxercesc_1_1DOMError.html#a06f5236dfdc9368bc18bca5359747bdb" title="A XMLCh* indicating which related data is expected in relatedData. ">DOMError::getType</a> dependent data if any. </p>
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
</div>
</div>
<a class="anchor" id="a434ccbd1bdb9fe3f08c044104f3d156a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void* xercesc::DOMError::getRelatedException </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The related platform dependent exception if any. </p>
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
</div>
</div>
<a class="anchor" id="ab0f9273c1b622184c7c189189355fe24"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMError.html#a2ee4056c45823760a3d9af523c263255">ErrorSeverity</a> xercesc::DOMError::getSeverity </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the severity of the error. </p>
<dl class="section see"><dt>See Also</dt><dd>setSeverity </dd></dl>
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
</div>
</div>
<a class="anchor" id="a06f5236dfdc9368bc18bca5359747bdb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* xercesc::DOMError::getType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A <code>XMLCh*</code> indicating which related data is expected in relatedData. </p>
<p>Users should refer to the specification of the error in order to find its <code>XMLCh*</code> type and relatedData definitions if any.</p>
<p>Note: As an example, <code><a class="el" href="classxercesc_1_1DOMDocument.html#ac4a3e3ffb33ce907f211d216b356f8fb" title="This method acts as if the document was going through a save and load cycle, putting the document in ...">DOMDocument::normalizeDocument()</a></code> does generate warnings when the "split-cdata-sections" parameter is in use. Therefore, the method generates a DOM_SEVERITY_WARNING with type "cdata-sections-splitted" and the first <code><a class="el" href="classxercesc_1_1DOMCDATASection.html" title="CDATA sections are used to escape blocks of text containing characters that would otherwise be regard...">DOMCDATASection</a></code> node in document order resulting from the split is returned by the relatedData attribute.</p>
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DOMError_8hpp_source.html">DOMError.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>