File: qsqlerror.html

package info (click to toggle)
qt4-x11 4%3A4.8.2%2Bdfsg-11
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 701,696 kB
  • sloc: cpp: 2,686,179; ansic: 375,485; python: 25,859; sh: 19,349; xml: 17,091; perl: 14,765; yacc: 5,383; asm: 5,038; makefile: 1,259; lex: 555; ruby: 526; objc: 347; cs: 112; pascal: 112; php: 54; sed: 34
file content (186 lines) | stat: -rw-r--r-- 14,834 bytes parent folder | download 
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qsqlerror.cpp -->
  <title>Qt 4.8: QSqlError Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtsql.html">QtSql</a></li>
<li>QSqlError</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QSqlError Class Reference</h1>
<!-- $$$QSqlError-brief -->
<p>The QSqlError class provides SQL database error information. <a href="#details">More...</a></p>
<!-- @@@QSqlError -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QSqlError&gt;</span></pre><ul>
<li><a href="qsqlerror-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qsqlerror.html#ErrorType-enum">ErrorType</a></b> { NoError, ConnectionError, StatementError, TransactionError, UnknownError }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsqlerror.html#QSqlError">QSqlError</a></b> ( const QString &amp; <i>driverText</i> = QString(), const QString &amp; <i>databaseText</i> = QString(), ErrorType <i>type</i> = NoError, int <i>number</i> = -1 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsqlerror.html#QSqlError-2">QSqlError</a></b> ( const QSqlError &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsqlerror.html#dtor.QSqlError">~QSqlError</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qsqlerror.html#databaseText">databaseText</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qsqlerror.html#driverText">driverText</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsqlerror.html#isValid">isValid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qsqlerror.html#number">number</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsqlerror.html#setDatabaseText">setDatabaseText</a></b> ( const QString &amp; <i>databaseText</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsqlerror.html#setDriverText">setDriverText</a></b> ( const QString &amp; <i>driverText</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsqlerror.html#setNumber">setNumber</a></b> ( int <i>number</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsqlerror.html#setType">setType</a></b> ( ErrorType <i>type</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qsqlerror.html#text">text</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ErrorType </td><td class="memItemRight bottomAlign"><b><a href="qsqlerror.html#type">type</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSqlError &amp; </td><td class="memItemRight bottomAlign"><b><a href="qsqlerror.html#operator-eq">operator=</a></b> ( const QSqlError &amp; <i>other</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$QSqlError-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QSqlError class provides SQL database error information.</p>
<p>A QSqlError object can provide database-specific error data, including the <a href="qsqlerror.html#driverText">driverText</a>() and <a href="qsqlerror.html#databaseText">databaseText</a>() messages (or both concatenated together as <a href="qsqlerror.html#text">text</a>()), and the error <a href="qsqlerror.html#number">number</a>() and <a href="qsqlerror.html#type">type</a>(). The functions all have setters so that you can create and return QSqlError objects from your own classes, for example from your own SQL drivers.</p>
</div>
<p><b>See also </b><a href="qsqldatabase.html#lastError">QSqlDatabase::lastError</a>() and <a href="qsqlquery.html#lastError">QSqlQuery::lastError</a>().</p>
<!-- @@@QSqlError -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$ErrorType$$$NoError$$$ConnectionError$$$StatementError$$$TransactionError$$$UnknownError$$$None$$$Connection$$$Statement$$$Transaction$$$Unknown -->
<h3 class="fn"><a name="ErrorType-enum"></a>enum QSqlError::<span class="name">ErrorType</span></h3>
<p>This enum type describes the context in which the error occurred, e.g&#x2e;, a connection error, a statement error, etc.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QSqlError::NoError</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">No error occurred.</td></tr>
<tr><td class="topAlign"><tt>QSqlError::ConnectionError</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">Connection error.</td></tr>
<tr><td class="topAlign"><tt>QSqlError::StatementError</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">SQL statement syntax error.</td></tr>
<tr><td class="topAlign"><tt>QSqlError::TransactionError</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">Transaction failed error.</td></tr>
<tr><td class="topAlign"><tt>QSqlError::UnknownError</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">Unknown error.</td></tr>
</table>
<!-- @@@ErrorType -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QSqlError[overload1]$$$QSqlErrorconstQString&constQString&ErrorTypeint -->
<h3 class="fn"><a name="QSqlError"></a>QSqlError::<span class="name">QSqlError</span> ( const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>driverText</i> = QString(), const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>databaseText</i> = QString(), <span class="type"><a href="qsqlerror.html#ErrorType-enum">ErrorType</a></span> <i>type</i> = NoError, <span class="type">int</span> <i>number</i> = -1 )</h3>
<p>Constructs an error containing the driver error text <i>driverText</i>, the database-specific error text <i>databaseText</i>, the type <i>type</i> and the optional error number <i>number</i>.</p>
<!-- @@@QSqlError -->
<!-- $$$QSqlError$$$QSqlErrorconstQSqlError& -->
<h3 class="fn"><a name="QSqlError-2"></a>QSqlError::<span class="name">QSqlError</span> ( const <span class="type">QSqlError</span> &amp; <i>other</i> )</h3>
<p>Creates a copy of <i>other</i>.</p>
<!-- @@@QSqlError -->
<!-- $$$~QSqlError[overload1]$$$~QSqlError -->
<h3 class="fn"><a name="dtor.QSqlError"></a>QSqlError::<span class="name">~QSqlError</span> ()</h3>
<p>Destroys the object and frees any allocated resources.</p>
<!-- @@@~QSqlError -->
<!-- $$$databaseText[overload1]$$$databaseText -->
<h3 class="fn"><a name="databaseText"></a><span class="type"><a href="qstring.html">QString</a></span> QSqlError::<span class="name">databaseText</span> () const</h3>
<p>Returns the text of the error as reported by the database. This may contain database-specific descriptions; it may be empty.</p>
<p><b>See also </b><a href="qsqlerror.html#setDatabaseText">setDatabaseText</a>(), <a href="qsqlerror.html#driverText">driverText</a>(), and <a href="qsqlerror.html#text">text</a>().</p>
<!-- @@@databaseText -->
<!-- $$$driverText[overload1]$$$driverText -->
<h3 class="fn"><a name="driverText"></a><span class="type"><a href="qstring.html">QString</a></span> QSqlError::<span class="name">driverText</span> () const</h3>
<p>Returns the text of the error as reported by the driver. This may contain database-specific descriptions. It may also be empty.</p>
<p><b>See also </b><a href="qsqlerror.html#setDriverText">setDriverText</a>(), <a href="qsqlerror.html#databaseText">databaseText</a>(), and <a href="qsqlerror.html#text">text</a>().</p>
<!-- @@@driverText -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QSqlError::<span class="name">isValid</span> () const</h3>
<p>Returns true if an error is set, otherwise false.</p>
<p>Example:</p>
<pre class="cpp"> <span class="type"><a href="qsqlquerymodel.html">QSqlQueryModel</a></span> model;
 model<span class="operator">.</span>setQuery(<span class="string">&quot;select * from myTable&quot;</span>);
 <span class="keyword">if</span> (model<span class="operator">.</span>lastError()<span class="operator">.</span>isValid())
     <a href="qtglobal.html#qDebug">qDebug</a>() <span class="operator">&lt;</span><span class="operator">&lt;</span> model<span class="operator">.</span>lastError();</pre>
<p><b>See also </b><a href="qsqlerror.html#type">type</a>().</p>
<!-- @@@isValid -->
<!-- $$$number[overload1]$$$number -->
<h3 class="fn"><a name="number"></a><span class="type">int</span> QSqlError::<span class="name">number</span> () const</h3>
<p>Returns the database-specific error number, or -1 if it cannot be determined.</p>
<p><b>See also </b><a href="qsqlerror.html#setNumber">setNumber</a>().</p>
<!-- @@@number -->
<!-- $$$setDatabaseText[overload1]$$$setDatabaseTextconstQString& -->
<h3 class="fn"><a name="setDatabaseText"></a><span class="type">void</span> QSqlError::<span class="name">setDatabaseText</span> ( const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>databaseText</i> )</h3>
<p>Sets the database error text to the value of <i>databaseText</i>.</p>
<p><b>See also </b><a href="qsqlerror.html#databaseText">databaseText</a>(), <a href="qsqlerror.html#setDriverText">setDriverText</a>(), and <a href="qsqlerror.html#text">text</a>().</p>
<!-- @@@setDatabaseText -->
<!-- $$$setDriverText[overload1]$$$setDriverTextconstQString& -->
<h3 class="fn"><a name="setDriverText"></a><span class="type">void</span> QSqlError::<span class="name">setDriverText</span> ( const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>driverText</i> )</h3>
<p>Sets the driver error text to the value of <i>driverText</i>.</p>
<p><b>See also </b><a href="qsqlerror.html#driverText">driverText</a>(), <a href="qsqlerror.html#setDatabaseText">setDatabaseText</a>(), and <a href="qsqlerror.html#text">text</a>().</p>
<!-- @@@setDriverText -->
<!-- $$$setNumber[overload1]$$$setNumberint -->
<h3 class="fn"><a name="setNumber"></a><span class="type">void</span> QSqlError::<span class="name">setNumber</span> ( <span class="type">int</span> <i>number</i> )</h3>
<p>Sets the database-specific error number to <i>number</i>.</p>
<p><b>See also </b><a href="qsqlerror.html#number">number</a>().</p>
<!-- @@@setNumber -->
<!-- $$$setType[overload1]$$$setTypeErrorType -->
<h3 class="fn"><a name="setType"></a><span class="type">void</span> QSqlError::<span class="name">setType</span> ( <span class="type"><a href="qsqlerror.html#ErrorType-enum">ErrorType</a></span> <i>type</i> )</h3>
<p>Sets the error type to the value of <i>type</i>.</p>
<p><b>See also </b><a href="qsqlerror.html#type">type</a>().</p>
<!-- @@@setType -->
<!-- $$$text[overload1]$$$text -->
<h3 class="fn"><a name="text"></a><span class="type"><a href="qstring.html">QString</a></span> QSqlError::<span class="name">text</span> () const</h3>
<p>This is a convenience function that returns <a href="qsqlerror.html#databaseText">databaseText</a>() and <a href="qsqlerror.html#driverText">driverText</a>() concatenated into a single string.</p>
<p><b>See also </b><a href="qsqlerror.html#driverText">driverText</a>() and <a href="qsqlerror.html#databaseText">databaseText</a>().</p>
<!-- @@@text -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn"><a name="type"></a><span class="type"><a href="qsqlerror.html#ErrorType-enum">ErrorType</a></span> QSqlError::<span class="name">type</span> () const</h3>
<p>Returns the error type, or -1 if the type cannot be determined.</p>
<p><b>See also </b><a href="qsqlerror.html#setType">setType</a>().</p>
<!-- @@@type -->
<!-- $$$operator=[overload1]$$$operator=constQSqlError& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QSqlError</span> &amp; QSqlError::<span class="name">operator=</span> ( const <span class="type">QSqlError</span> &amp; <i>other</i> )</h3>
<p>Assigns the <i>other</i> error's values to this error.</p>
<!-- @@@operator= -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2012 Nokia Corporation and/or its
      subsidiaries. Documentation contributions included herein are the copyrights of
      their respective owners.</p>
    <br />
    <p>
      The documentation provided herein is licensed under the terms of the
      <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
      License version 1.3</a> as published by the Free Software Foundation.</p>
    <p>
      Documentation sources may be obtained from <a href="http://www.qt-project.org">
      www.qt-project.org</a>.</p>
    <br />
    <p>
      Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
      in Finland and/or other countries worldwide. All other trademarks are property
      of their respective owners. <a title="Privacy Policy"
      href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>