Source of: /manual/en/pdo.errorcode.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.pdo.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'pdo.errorcode.php',
1 => 'PDO::errorCode',
),
'up' =>
array (
0 => 'class.pdo.php',
1 => 'The PDO class',
),
'prev' =>
array (
0 => 'pdo.construct.php',
1 => 'PDO::__construct',
),
'next' =>
array (
0 => 'pdo.errorinfo.php',
1 => 'PDO::errorInfo',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="pdo.errorcode" class="refentry">
<div class="refnamediv">
<h1 class="refname">PDO::errorCode</h1>
<p class="verinfo">(PHP 5 >= 5.1.0, PECL pdo >= 0.1.0)</p><p class="refpurpose"><span class="refname">PDO::errorCode</span> — <span class="dc-title">
Fetch the SQLSTATE associated with the last operation on the database handle
</span></p>
</div>
<a name="pdo.errorcode.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><b>PDO::errorCode</b></span>
( <span class="methodparam">void</span>
)</div>
</div>
<a name="pdo.errorcode.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a SQLSTATE, a five characters alphanumeric identifier defined in
the ANSI SQL-92 standard. Briefly, an SQLSTATE consists of a
two characters class value followed by a three characters subclass value. A
class value of 01 indicates a warning and is accompanied by a return code
of SQL_SUCCESS_WITH_INFO. Class values other than '01', except for the
class 'IM', indicate an error. The class 'IM' is specific to warnings
and errors that derive from the implementation of PDO (or perhaps ODBC,
if you're using the ODBC driver) itself. The subclass value '000' in any
class indicates that there is no subclass for that SQLSTATE.
</p>
<p class="para">
<b>PDO::errorCode()</b> only retrieves error codes for operations
performed directly on the database handle. If you create a PDOStatement
object through <a href="pdo.prepare.php" class="function">PDO::prepare()</a> or
<a href="pdo.query.php" class="function">PDO::query()</a> and invoke an error on the statement
handle, <b>PDO::errorCode()</b> will not reflect that error.
You must call <a href="pdostatement.errorcode.php" class="function">PDOStatement::errorCode()</a> to return the error
code for an operation performed on a particular statement handle.
</p>
<p class="para">
Returns <b><tt class="constant">NULL</tt></b> if no operation has been run on the database handle.
</p>
</div>
<a name="pdo.errorcode.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example"><p><b>Example #1 Retrieving a SQLSTATE code</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/* Provoke an error -- the BONES table does not exist */<br /></span><span style="color: #0000BB">$dbh</span><span style="color: #007700">-></span><span style="color: #0000BB">exec</span><span style="color: #007700">(</span><span style="color: #DD0000">"INSERT INTO bones(skull) VALUES ('lucy')"</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"\nPDO::errorCode(): "</span><span style="color: #007700">;<br />print </span><span style="color: #0000BB">$dbh</span><span style="color: #007700">-></span><span style="color: #0000BB">errorCode</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
PDO::errorCode(): 42S02
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="pdo.errorcode.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="pdo.errorinfo.php" class="function" rel="rdfs-seeAlso">PDO::errorInfo()</a> - Fetch extended error information associated with the last operation on the database handle</li>
<li class="member"><a href="pdostatement.errorcode.php" class="function" rel="rdfs-seeAlso">PDOStatement::errorCode()</a> - Fetch the SQLSTATE associated with the last operation on the statement handle</li>
<li class="member"><a href="pdostatement.errorinfo.php" class="function" rel="rdfs-seeAlso">PDOStatement::errorInfo()</a> - Fetch extended error information associated with the last operation on the statement handle</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>