File: Poco.XML.SAXParseException.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (130 lines) | stat: -rw-r--r-- 14,233 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<!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>
<title>Class Poco::XML::SAXParseException</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.XML.html" class="namespace">Poco::XML</a></h1>
<h1 class="symbol">class SAXParseException</h1>
</div>
<div class="body">
<p>
<b>Library:</b> XML<br />
<b>Package:</b> SAX<br />
<b>Header:</b> Poco/SAX/SAXException.h</p>
<h2>Description</h2>
<div class="description">
<p><a href="Poco.Exception.html" title="class Poco::Exception">Exception</a> class for an unsupported operation. </p>
<p>An <a href="Poco.XML.XMLReader.html" title="class Poco::XML::XMLReader">XMLReader</a> will throw this exception when it recognizes a feature or property identifier,  but cannot perform the requested operation (setting a state or value). Other SAX2 applications  and extensions may use this class for similar purposes. Encapsulate an <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> parse error or warning. </p>
<p>This exception may include information for locating the error in the original <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> document,  as if it came from a <a href="Poco.XML.Locator.html" title="class Poco::XML::Locator">Locator</a> object. Note that although the application will receive a  <a href="Poco.XML.SAXParseException.html" title="class Poco::XML::SAXParseException">SAXParseException</a> as the argument to the handlers in the <a href="Poco.XML.ErrorHandler.html" title="class Poco::XML::ErrorHandler">ErrorHandler</a> interface, the application  is not actually required to throw the exception; instead, it can simply read the information in it  and take a different action. </p>
<p>Since this exception is a subclass of <a href="Poco.XML.SAXException.html" title="class Poco::XML::SAXException">SAXException</a>, it inherits the ability to wrap another exception. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b><a href="Poco.XML.SAXException.html" title="class Poco::XML::SAXException">SAXException</a></p>
<p><b>All Base Classes: </b><a href="Poco.Exception.html" title="class Poco::Exception">Poco::Exception</a>, <a href="Poco.RuntimeException.html" title="class Poco::RuntimeException">Poco::RuntimeException</a>, <a href="Poco.XML.SAXException.html" title="class Poco::XML::SAXException">SAXException</a>, <a href="Poco.XML.XMLException.html" title="class Poco::XML::XMLException">XMLException</a>, std::exception</p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.XML.SAXParseException.html#19216" title="Poco::XML::SAXParseException::buildMessage()">buildMessage</a>, <a href="Poco.XML.SAXParseException.html#19209" title="Poco::XML::SAXParseException::className()">className</a>, <a href="Poco.XML.SAXParseException.html#19210" title="Poco::XML::SAXParseException::clone()">clone</a>, <a href="Poco.XML.SAXParseException.html#19215" title="Poco::XML::SAXParseException::getColumnNumber()">getColumnNumber</a>, <a href="Poco.XML.SAXParseException.html#19214" title="Poco::XML::SAXParseException::getLineNumber()">getLineNumber</a>, <a href="Poco.XML.SAXParseException.html#19212" title="Poco::XML::SAXParseException::getPublicId()">getPublicId</a>, <a href="Poco.XML.SAXParseException.html#19213" title="Poco::XML::SAXParseException::getSystemId()">getSystemId</a>, <a href="Poco.XML.SAXParseException.html#19208" title="Poco::XML::SAXParseException::name()">name</a>, <a href="Poco.XML.SAXParseException.html#19206" title="Poco::XML::SAXParseException::operator =()">operator&nbsp;=</a>, <a href="Poco.XML.SAXParseException.html#19211" title="Poco::XML::SAXParseException::rethrow()">rethrow</a></p>
<p><b>Inherited Functions: </b><a href="Poco.Exception.html#5710" title="Poco::Exception::className()">className</a>, <a href="Poco.Exception.html#5716" title="Poco::Exception::clone()">clone</a>, <a href="Poco.Exception.html#5714" title="Poco::Exception::code()">code</a>, <a href="Poco.Exception.html#5715" title="Poco::Exception::displayText()">displayText</a>, <a href="Poco.Exception.html#5722" title="Poco::Exception::extendedMessage()">extendedMessage</a>, <a href="Poco.Exception.html#5713" title="Poco::Exception::message()">message</a>, <a href="Poco.Exception.html#5709" title="Poco::Exception::name()">name</a>, <a href="Poco.Exception.html#5712" title="Poco::Exception::nested()">nested</a>, <a href="Poco.Exception.html#5707" title="Poco::Exception::operator =()">operator&nbsp;=</a>, <a href="Poco.Exception.html#5717" title="Poco::Exception::rethrow()">rethrow</a>, <a href="Poco.Exception.html#5711" title="Poco::Exception::what()">what</a></p>
<h2>Constructors</h2>
<h3><a name="19203">SAXParseException</a></h3>
<p class="decl"><a href="Poco.XML.SAXParseException.html" title="class Poco::XML::SAXParseException">SAXParseException</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.SAXParseException.html" title="class Poco::XML::SAXParseException">SAXParseException</a> &amp; exc<br />);</p>
<div class="description">
<p>Creates a new <a href="Poco.XML.SAXParseException.html" title="class Poco::XML::SAXParseException">SAXParseException</a> from another one. </p>
</div>
<h3><a name="19183">SAXParseException</a></h3>
<p class="decl"><a href="Poco.XML.SAXParseException.html" title="class Poco::XML::SAXParseException">SAXParseException</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; msg,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.Locator.html" title="class Poco::XML::Locator">Locator</a> &amp; loc<br />);</p>
<div class="description">
<p>Create a new <a href="Poco.XML.SAXParseException.html" title="class Poco::XML::SAXParseException">SAXParseException</a> from a message and a <a href="Poco.XML.Locator.html" title="class Poco::XML::Locator">Locator</a>. </p>
</div>
<h3><a name="19186">SAXParseException</a></h3>
<p class="decl"><a href="Poco.XML.SAXParseException.html" title="class Poco::XML::SAXParseException">SAXParseException</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; msg,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.Locator.html" title="class Poco::XML::Locator">Locator</a> &amp; loc,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Exception.html" title="class Poco::Exception">Poco::Exception</a> &amp; exc<br />);</p>
<div class="description">
<p>Wrap an existing exception in a <a href="Poco.XML.SAXParseException.html" title="class Poco::XML::SAXParseException">SAXParseException</a>. </p>
</div>
<h3><a name="19190">SAXParseException</a></h3>
<p class="decl"><a href="Poco.XML.SAXParseException.html" title="class Poco::XML::SAXParseException">SAXParseException</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; msg,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; publicId,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; systemId,<br />&nbsp;&nbsp;&nbsp;&nbsp;int lineNumber,<br />&nbsp;&nbsp;&nbsp;&nbsp;int columnNumber<br />);</p>
<div class="description">
<p>Create a new <a href="Poco.XML.SAXParseException.html" title="class Poco::XML::SAXParseException">SAXParseException</a> with an embedded exception. </p>
<p>This constructor is most useful for parser writers. All parameters except the message are as if they were provided by a <a href="Poco.XML.Locator.html" title="class Poco::XML::Locator">Locator</a>.  For example, if the system identifier is a URL (including relative filename),  the caller must resolve it fully before creating the exception. </p>
</div>
<h3><a name="19196">SAXParseException</a></h3>
<p class="decl"><a href="Poco.XML.SAXParseException.html" title="class Poco::XML::SAXParseException">SAXParseException</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; msg,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; publicId,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; systemId,<br />&nbsp;&nbsp;&nbsp;&nbsp;int lineNumber,<br />&nbsp;&nbsp;&nbsp;&nbsp;int columnNumber,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Exception.html" title="class Poco::Exception">Poco::Exception</a> &amp; exc<br />);</p>
<div class="description">
<p>Create a new <a href="Poco.XML.SAXParseException.html" title="class Poco::XML::SAXParseException">SAXParseException</a>. </p>
<p>This constructor is most useful for parser writers. All parameters except the message are as if they were provided by a <a href="Poco.XML.Locator.html" title="class Poco::XML::Locator">Locator</a>.  For example, if the system identifier is a URL (including relative filename),  the caller must resolve it fully before creating the exception. </p>
</div>
<h2>Destructor</h2>
<h3><a name="19205">~SAXParseException</a></h3>
<p class="decl">~<a href="Poco.XML.SAXParseException.html" title="class Poco::XML::SAXParseException">SAXParseException</a>();</p>
<div class="description">
<p>Destroy the exception. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="19209">className</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const char * className() const;</p>
<div class="description">
<p>Returns the name of the exception class. </p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.XML.SAXException.html#19133" title="Poco::XML::SAXException::className()">Poco::XML::SAXException::className()</a></p></div>
<h3><a name="19210">clone</a></h3>
<p class="decl"><a href="Poco.Exception.html" title="class Poco::Exception">Poco::Exception</a> * clone() const;</p>
<div class="description">
<p>Creates an exact copy of the exception. </p>
</div>
<h3><a name="19215">getColumnNumber</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int getColumnNumber() const;</p>
<div class="description">
<p>The column number of the end of the text where the exception occurred. The first column in a line is position 1. </p>
</div>
<h3><a name="19214">getLineNumber</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int getLineNumber() const;</p>
<div class="description">
<p>The line number of the end of the text where the exception occurred. The first line is line 1. </p>
</div>
<h3><a name="19212">getPublicId</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; getPublicId() const;</p>
<div class="description">
<p>Get the public identifier of the entity where the exception occurred. </p>
</div>
<h3><a name="19213">getSystemId</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; getSystemId() const;</p>
<div class="description">
<p>Get the system identifier of the entity where the exception occurred. </p>
</div>
<h3><a name="19208">name</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const char * name() const;</p>
<div class="description">
<p>Returns a static string describing the exception. </p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.XML.SAXException.html#19132" title="Poco::XML::SAXException::name()">Poco::XML::SAXException::name()</a></p></div>
<h3><a name="19206">operator =</a></h3>
<p class="decl"><a href="Poco.XML.SAXParseException.html" title="class Poco::XML::SAXParseException">SAXParseException</a> &amp; operator = (<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.SAXParseException.html" title="class Poco::XML::SAXParseException">SAXParseException</a> &amp; exc<br />);</p>
<div class="description">
<p>Assignment operator. </p>
</div>
<h3><a name="19211">rethrow</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void rethrow() const;</p>
<div class="description">
<p>(Re)Throws the exception. </p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.XML.SAXException.html#19135" title="Poco::XML::SAXException::rethrow()">Poco::XML::SAXException::rethrow()</a></p></div>
<h3><a name="19216">buildMessage</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static std::string buildMessage(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; msg,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; publicId,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; systemId,<br />&nbsp;&nbsp;&nbsp;&nbsp;int lineNumber,<br />&nbsp;&nbsp;&nbsp;&nbsp;int columnNumber<br />);</p>
<div class="description">
<p></p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>