mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
e41806c30b
Document false and null return types Cf. <https://news-web.php.net/php.doc.cvs/17645>. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351730 c90b9560-bf6c-de11-be94-00142212c4b1
126 lines
4.1 KiB
XML
126 lines
4.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.58 -->
|
|
<refentry xml:id='function.pg-result-error-field' xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>pg_result_error_field</refname>
|
|
<refpurpose>Returns an individual field of an error report</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>pg_result_error_field</methodname>
|
|
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>fieldcode</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>pg_result_error_field</function> returns one of the detailed error message
|
|
fields associated with <parameter>result</parameter> resource. It is only available
|
|
against a PostgreSQL 7.4 or above server. The error field is specified by
|
|
the <parameter>fieldcode</parameter>.
|
|
</para>
|
|
<para>
|
|
Because <function>pg_query</function> and <function>pg_query_params</function> return &false; if the query fails,
|
|
you must use <function>pg_send_query</function> and
|
|
<function>pg_get_result</function> to get the result handle.
|
|
</para>
|
|
<para>
|
|
If you need to get additional error information from failed <function>pg_query</function> queries,
|
|
use <function>pg_set_error_verbosity</function> and <function>pg_last_error</function>
|
|
and then parse the result.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>result</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A PostgreSQL query result resource from a previously executed
|
|
statement.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>fieldcode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Possible <parameter>fieldcode</parameter> values are: <constant>PGSQL_DIAG_SEVERITY</constant>,
|
|
<constant>PGSQL_DIAG_SQLSTATE</constant>, <constant>PGSQL_DIAG_MESSAGE_PRIMARY</constant>,
|
|
<constant>PGSQL_DIAG_MESSAGE_DETAIL</constant>,
|
|
<constant>PGSQL_DIAG_MESSAGE_HINT</constant>, <constant>PGSQL_DIAG_STATEMENT_POSITION</constant>,
|
|
<constant>PGSQL_DIAG_INTERNAL_POSITION</constant> (PostgreSQL 8.0+ only),
|
|
<constant>PGSQL_DIAG_INTERNAL_QUERY</constant> (PostgreSQL 8.0+ only),
|
|
<constant>PGSQL_DIAG_CONTEXT</constant>, <constant>PGSQL_DIAG_SOURCE_FILE</constant>,
|
|
<constant>PGSQL_DIAG_SOURCE_LINE</constant> or
|
|
<constant>PGSQL_DIAG_SOURCE_FUNCTION</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>A <type>string</type> containing the contents of the error field, &null; if the field does not exist or &false;
|
|
on failure.</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>pg_result_error_field</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$dbconn = pg_connect("dbname=publisher") or die("Could not connect");
|
|
|
|
if (!pg_connection_busy($dbconn)) {
|
|
pg_send_query($dbconn, "select * from doesnotexist;");
|
|
}
|
|
|
|
$res1 = pg_get_result($dbconn);
|
|
echo pg_result_error_field($res1, PGSQL_DIAG_SQLSTATE);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>pg_result_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
|
|
-->
|