pg-set-error-verbosity.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: takagi Status: ready -->
<refentry xml:id="function.pg-set-error-verbosity" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_set_error_verbosity</refname>
  <refpurpose>
   <function>pg_last_error</function> および <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>PgSql\Connection</type><parameter>connection</parameter></methodparam>
   <methodparam><type>int</type><parameter>verbosity</parameter></methodparam>
  </methodsynopsis>
  <para>
    <function>pg_last_error</function> および <function>pg_result_error</function>
    が返すメッセージの詳細度を指定します。
  </para>
  <para>
   <function>pg_set_error_verbosity</function> は詳細度を設定し、その接続の
   これまでの設定を返します。<constant>PGSQL_ERRORS_TERSE</constant>
   モードでは、返されるメッセージは深刻度・概要 および 発生位置のみです。
   これはたいていの場合 1 行に収まります。デフォルトのモード
   （<constant>PGSQL_ERRORS_DEFAULT</constant>）では、それに加えて何らかの
   詳細情報・ヒントあるいは状況フィールドを含みます（これらは複数行に
   またがる可能性があります）。<constant>PGSQL_ERRORS_VERBOSE</constant>
   モードは、有効なフィールドをすべて含みます。詳細度の設定変更内容は
   それ以降に新しく作成した結果オブジェクトにのみ反映され、既存の
   結果オブジェクトには影響を与えません。
  </para>
 </refsect1>

<refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      &pgsql.parameter.connection-with-unspecified-default;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>verbosity</parameter></term>
     <listitem>
      <para>
       指定する詳細度。<constant>PGSQL_ERRORS_TERSE</constant>、
       <constant>PGSQL_ERRORS_DEFAULT</constant>
       あるいは <constant>PGSQL_ERRORS_VERBOSE</constant> 。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   変更前の詳細度レベル。<constant>PGSQL_ERRORS_TERSE</constant>、
   <constant>PGSQL_ERRORS_DEFAULT</constant>
   あるいは <constant>PGSQL_ERRORS_VERBOSE</constant> のいずれかを
   返します。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &pgsql.changelog.connection-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_set_error_verbosity</function> の例</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
-->