php-doc-en/reference/pgsql/functions/pg-set-error-verbosity.xml
2018-01-25 15:34:22 +00:00

127 lines
4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.16 -->
<refentry xml:id="function.pg-set-error-verbosity" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pg_set_error_verbosity</refname>
<refpurpose>
Determines the verbosity of messages returned by <function>pg_last_error</function>
and <function>pg_result_error</function>
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_set_error_verbosity</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>verbosity</parameter></methodparam>
</methodsynopsis>
<para>
Determines the verbosity of messages returned by <function>pg_last_error</function>
and <function>pg_result_error</function>.
</para>
<para>
<function>pg_set_error_verbosity</function> sets the verbosity mode, returning the connection's previous
setting. In <constant>PGSQL_ERRORS_TERSE</constant> mode, returned messages include severity, primary text, and
position only; this will normally fit on a single line. The default mode (<constant>PGSQL_ERRORS_DEFAULT</constant>)
produces messages that include the above plus any detail, hint, or context
fields (these may span multiple lines). The <constant>PGSQL_ERRORS_VERBOSE</constant> mode includes all available
fields. Changing the verbosity does not affect the messages available from
already-existing result objects, only subsequently-created ones.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
PostgreSQL database connection resource. When
<parameter>connection</parameter> is not present, the default connection
is used. The default connection is the last connection made by
<function>pg_connect</function> or <function>pg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>verbosity</parameter></term>
<listitem>
<para>
The required verbosity: <constant>PGSQL_ERRORS_TERSE</constant>,
<constant>PGSQL_ERRORS_DEFAULT</constant>
or <constant>PGSQL_ERRORS_VERBOSE</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The previous verbosity level: <constant>PGSQL_ERRORS_TERSE</constant>,
<constant>PGSQL_ERRORS_DEFAULT</constant>
or <constant>PGSQL_ERRORS_VERBOSE</constant>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_set_error_verbosity</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;");
}
pg_set_error_verbosity($dbconn, PGSQL_ERRORS_VERBOSE);
$res1 = pg_get_result($dbconn);
echo pg_result_error($res1);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>pg_last_error</function></member>
<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
-->