php-doc-en/reference/mysqli/mysqli_sql_exception/getsqlstate.xml
Máté Kocsis 213798ecf0
Document mysqli_sql_exception::getSqlState() (#1310)
Co-authored-by: Kamil Tekiela <tekiela246@gmail.com>
2022-01-10 14:55:43 +01:00

60 lines
1.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysqli-sql-exception.getsqlstate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mysqli_sql_exception::getSqlState</refname>
<refpurpose>Returns the SQLSTATE error code</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>mysqli_sql_exception::getSqlState</methodname>
<void/>
</methodsynopsis>
<para>
Returns a string containing the SQLSTATE error code for the last error.
The error code consists of five characters.
The values are specified by ANSI SQL and ODBC. For a list of possible values, see
<link xlink:href="&url.mysql.docs.error;">&url.mysql.docs.error;</link>.
</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 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a string containing the SQLSTATE error code for the last error. The error code consists of five characters.
</para>
</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:"~/.phpdoc/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
-->