php-doc-en/reference/ingres-ii/functions/ingres-error.xml
Philip Olson 04b11e621f Fixed spelling
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@329325 c90b9560-bf6c-de11-be94-00142212c4b1
2013-01-29 01:47:09 +00:00

114 lines
2.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ingres-error" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ingres_error</refname>
<refpurpose>Get a meaningful error message for the last error generated</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ingres_error</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
Returns a string containing the last error, or NULL if no error has
occurred.
</para>
<para>
If a <parameter>link</parameter> resource is passed to
<function>ingres_error</function>, it returns the last error recorded for
the link. If no link is passed then <function>ingres_error</function>
returns the last error reported using the default link.
</para>
<para>
The function, <function>ingres_error</function>, should always be called
after executing any database query. Calling another function before
<function>ingres_error</function> is called will reset or change any
error message from the last Ingres function call.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link</parameter></term>
<listitem>
<para>
The connection link identifier
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a string containing the last error, or NULL if no error has
occurred.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Get a message for the last error generated</title>
<programlisting role="php">
<![CDATA[
<?php
$link = ingres_connect($database, $user, $password);
$result = ingres_query($link, "select * from table");
$error_text = ingres_error();
if (!is_null($error_text)) {
echo "An error occurred - " . $error_text;
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ingres_errno</function></member>
<member><function>ingres_errsqlstate</function></member>
<member><function>ingres_next_error</function></member>
</simplelist>
</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
-->