archived-doc-de/reference/pgsql/functions/pg-result-status.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: conni Status: ready -->
<refentry xml:id='function.pg-result-status' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_result_status</refname>
  <refpurpose>
   Gibt den Status eines Abfrageergebnisses zurück
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>pg_result_status</methodname>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_result_status</function> gibt den Status eines
   Abfrageergebnisses zurück oder das mit dem Ergebnis verknüpfte PostgreSQL
   Kommando-Tag, wenn die Abfrage erfolgreich war.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      <para>
       PostgreSQL Ergebniskennung, die (unter anderem) von den
       Funktionen <function>pg_query</function>,
       <function>pg_query_params</function> oder 
       <function>pg_execute</function> zurückgegeben wurde.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       Entweder <constant>PGSQL_STATUS_LONG</constant>, um die
       Statusnummer von <parameter>result</parameter> zu erhalten, oder
       <constant>PGSQL_STATUS_STRING</constant>, um das PostgreSQL Kommando-Tag für das
       <parameter>result</parameter> zu erhalten. Falls nichts angegeben
       wurde, wird der Vorgabewert <constant>PGSQL_STATUS_LONG</constant> zurückgegeben.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Mögliche Rückgabewerte sind <constant>PGSQL_EMPTY_QUERY</constant>,
   <constant>PGSQL_COMMAND_OK</constant>, <constant>PGSQL_TUPLES_OK</constant>, <constant>PGSQL_COPY_OUT</constant>,
   <constant>PGSQL_COPY_IN</constant>, <constant>PGSQL_BAD_RESPONSE</constant>, <constant>PGSQL_NONFATAL_ERROR</constant> und
   <constant>PGSQL_FATAL_ERROR</constant>, falls <constant>PGSQL_STATUS_LONG</constant> angegeben wurde.
   Anderenfalls wird ein <type>string</type> zurückgegeben, der das
   PostgreSQL Kommando-Tag enthält.
  </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>4.3.0</entry>
       <entry>
        Der Parameter <parameter>type</parameter> wurde hinzugefügt.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_result_status</function> Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php

// Zur Datenbank verbinden
$conn = pg_pconnect("dbname=publisher");

// Eine Abfrage ausführen
$result = pg_query($conn, "COPY authors FROM STDIN;");

// Den Status des Abfrageergebnisses holen
$status = pg_result_status($result);

// Den Status ermitteln
if ($status == PGSQL_COPY_IN)
   echo "Copy begonnen.";
else
   echo "Copy fehlgeschlagen."; 
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Copy begonnen.
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_connection_status</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
-->