<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.pg-result-error-field" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>pg_result_error_field</refname>

<refpurpose>エラー報告の各フィールドを返す</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>string</type><type>false</type><type>null</type></type><methodname>pg_result_error_field</methodname>

<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>

<methodparam><type>int</type><parameter>field_code</parameter></methodparam>

</methodsynopsis>

<para>

<function>pg_result_error_field</function> は、

<parameter>result</parameter>

インスタンスに関するエラーメッセージの特定のフィールドを返します。

エラーフィールドは

<parameter>field_code</parameter> で定義します。

</para>

<para>

<function>pg_query</function> や <function>pg_query_params</function>

はクエリが失敗した場合に &false; を返すので、結果のハンドルを得るには

<function>pg_send_query</function> および

<function>pg_get_result</function> を使用する必要があります。

</para>

<para>

失敗した <function>pg_query</function> クエリから詳細なエラー情報を

取得する必要がある場合は、<function>pg_set_error_verbosity</function>

および <function>pg_last_error</function> を使用してその結果をパース

します。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>result</parameter></term>

<listitem>

&pgsql.parameter.result;

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>field_code</parameter></term>

<listitem>

<para>

以下の <parameter>field_code</parameter> が使用可能です。 <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>、

<constant>PGSQL_DIAG_INTERNAL_QUERY</constant>、

<constant>PGSQL_DIAG_CONTEXT</constant>、<constant>PGSQL_DIAG_SOURCE_FILE</constant>、

<constant>PGSQL_DIAG_SOURCE_LINE</constant> あるいは

<constant>PGSQL_DIAG_SOURCE_FUNCTION</constant> 。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>エラーフィールドの内容を文字列で返します。

フィールドが存在しない場合に &null; 、失敗した場合に &false;

を返します。</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

&pgsql.changelog.result-object;

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>pg_result_error_field</function> の例</title>

<programlisting role="php">

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>pg_result_error</function></member>

</simplelist>

</para>

</refsect1>

</refentry>