php-doc-en/reference/mysqli/functions/mysqli-sqlstate.xml
2004-07-27 04:48:55 +00:00

126 lines
3.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-sqlstate">
<refnamediv>
<refname>mysqli_sqlstate</refname>
<refname>mysqli->sqlstate</refname>
<refpurpose>Returns the SQLSTATE error from previous MySQL operation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_sqlstate</methodname>
<methodparam><type>object</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<fieldsynopsis><type>string</type><varname>sqlstate</varname></fieldsynopsis>
</classsynopsis>
<para>
Returns a string containing the SQLSTATE error code for the last error.
The error code consists of five characters. <literal>'00000'</literal> means no error.
The values are specified by ANSI SQL and ODBC. For a list of possible values, see
<ulink url="&url.mysql.docs.error;">&url.mysql.docs.error;</ulink>.
</para>
<note>
<para>
Note that not all MySQL errors are yet mapped to SQLSTATE's.
The value <literal>HY000</literal> (general error) is used for unmapped errors.
</para>
</note>
</refsect1>
<refsect1>
<title>Return values</title>
<para>
Returns a string containing the SQLSTATE error code for the last error.
The error code consists of five characters. <literal>'00000'</literal> means no error.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>mysqli_errno</function>,
<function>mysqli_error</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<example>
<title>Object oriented style</title>
<programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
/* check connection */
if (mysqli_connect_errno()) {
printf("Connect failed: %s\n", mysqli_connect_error());
exit();
}
/* Table City already exists, so we should get an error */
if (!$mysqli->query("CREATE TABLE City (ID INT, Name VARCHAR(30))")) {
printf("Error - SQLSTATE %s.\n", $mysqli->sqlstate);
}
$mysqli->close();
?>
]]>
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
<![CDATA[
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");
/* check connection */
if (mysqli_connect_errno()) {
printf("Connect failed: %s\n", mysqli_connect_error());
exit();
}
/* Table City already exists, so we should get an error */
if (!mysqli_query($link, "CREATE TABLE City (ID INT, Name VARCHAR(30))")) {
printf("Error - SQLSTATE %s.\n", mysqli_sqlstate($link));
}
mysqli_close($link);
?>
]]>
</programlisting>
</example>
<para>
The above examples would produce the following output:
</para>
<screen>
<![CDATA[
Error - SQLSTATE 42S01.
]]>
</screen>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->