php-doc-en/reference/oracle/functions/ora-error.xml
Philip Olson 245cab7fc0 Documented ref.oci8 alternatives for each oracle function. Information taken
from user notes provided by christopher dot jones at oracle dot com.
And, added a changelog to each function mentioning ref.oracle is deprecated
as of PHP 5.1.0.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229243 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-07 06:51:55 +00:00

135 lines
3.2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<refentry id="function.ora-error">
<refnamediv>
<refname>ora_error</refname>
<refpurpose>Gets an Oracle error message</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ora_error</methodname>
<methodparam choice="opt"><type>resource</type><parameter>cursor_or_connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns the error message of the last executed statement on the
specified cursor or connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cursor_or_connection</parameter></term>
<listitem>
<para>
An Oracle cursor or connection identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an error message of the form
<replaceable>XXX</replaceable>-<replaceable>NNNNN</replaceable>
where <replaceable>XXX</replaceable> is where the error comes
from and <replaceable>NNNNN</replaceable> identifies the error
message.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.1.0</entry>
<entry>
&oracle.deprecated;
</entry>
</row>
<row>
<entry>3.0.4</entry>
<entry>
Support for connection identifiers was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
On Unix versions of Oracle, you can find details about an error
message like this:
<informalexample>
<programlisting role="shell">
<![CDATA[
$> oerr ora 00001
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
00001, 00000,
"unique constraint (%s.%s) violated" // *Cause: An update or insert
statement attempted to insert a duplicate key // For Trusted
ORACLE configured in DBMS MAC mode, you may see // this message
if a duplicate entry exists at a different level. // *Action: Either
remove the unique restriction or do not insert the key
]]>
</screen>
</informalexample>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<para>
&oracle.replacement.desc;
<simplelist>
<member><function>oci_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:"../../../../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
-->