cvs: phpdoc /en/reference/pdo/functions PDOStatement-errorInfo.xml

dbs Fri Nov 26 14:55:05 2004 EDT Modified files: /phpdoc/en/reference/pdo/functions PDOStatement-errorInfo.xml Log: Describe the errorInfo() array, add example. http://cvs.php.net/diff.php/phpdoc/en/reference/pdo/functions/PDOStatement-errorInfo.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/pdo/functions/PDOStatement-errorInfo.xml diff -u phpdoc/en/reference/pdo/functions/PDOStatement-errorInfo.xml:1.2 phpdoc/en/reference/pdo/functions/PDOStatement-errorInfo.xml:1.3 --- phpdoc/en/reference/pdo/functions/PDOStatement-errorInfo.xml:1.2 Thu Nov 11 03:16:32 2004 +++ phpdoc/en/reference/pdo/functions/PDOStatement-errorInfo.xml Fri Nov 26 14:55:05 2004 @@ -1,11 +1,11 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <refentry id="function.PDOStatement-errorInfo"> <refnamediv> <refname>PDOStatement::errorInfo</refname> <refpurpose> - Fetch extended error information associated with the last operation on the statement handle + Fetch an array of error information associated with the last operation on the statement handle </refpurpose> </refnamediv> <refsect1> @@ -15,7 +15,66 @@ <void/> </methodsynopsis> - &warn.undocumented.func; + &warn.experimental.func; + <para> + <function>PDOStatement::errorInfo</function> returns an array of + error information about the last operation performed by this + statement handle. The array consists of the following fields: + <informaltable> + <tgroup cols='2'> + <thead> + <row> + <entry>Element</entry> + <entry>Information</entry> + </row> + </thead> + <tbody> + <row> + <entry>0</entry> + <entry>Generic PDO error code corresponding to one of the + <literal>PDO_ERR_*</literal> constants.</entry> + </row> + <row> + <entry>1</entry> + <entry>Driver-specific error code.</entry> + </row> + <row> + <entry>2</entry> + <entry>Driver-specific error message.</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + + <example><title>Displaying errorInfo() fields for a PDO_ODBC connection to a DB2 database</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* Provoke an error -- the BONES table does not exist */ +$sth = $dbh->prepare('SELECT skull FROM bones'); +$sth->execute(); + +$arr = $sth->errorInfo(); +if ($arr[0] == PDO_ERR_NOT_FOUND) { + echo "Error: a requested database object does not exist.\n"; + printf("Driver-specific error code: %d\n", $arr[1]); + printf("Driver-specific message: [%s]\n", $arr[2]); +} +?> +]]> + </programlisting> + </example> + &example.outputs; + <screen> +<![CDATA[ +Error: a requested database object does not exist. +Driver-specific error code: -204 +Driver-specific message: [SQLExecute: -204 [IBM][CLI Driver][DB2/NT] +SQL0204N "DB2INST1.BONES" is an undefined name. SQLSTATE=42704 + [SQL State 42S02] (..\pecl\pdo_odbc\odbc_stmt.c:80)] +]]> + </screen> </refsect1> </refentry>