Files
doc-fr/reference/pgsql/functions/pg-result-status.xml
George Peter Banyard 8e82164d85 Apply commit c2eca73ef79ebe78cebb34053e41b565af504c4f
[PHP 8.1] Use PgSql objects instead of resources
2021-10-16 20:03:39 +01:00

147 lines
4.0 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.pg-result-status" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pg_result_status</refname>
<refpurpose>Lit le statut du résultat</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>int</type></type><methodname>pg_result_status</methodname>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>PGSQL_STATUS_LONG</constant></initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_result_status</function> retourne le statut du résultat
<parameter>result</parameter> ou la commande d'exécution de PostgreSQL
associée au résultat.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Soit <constant>PGSQL_STATUS_LONG</constant> pour retourner un statut
numérique de <parameter>result</parameter> ou
<constant>PGSQL_STATUS_STRING</constant> pour retourner le tag de la
commande de <parameter>result</parameter>. Si l'argument n'est pas
spécifié, <constant>PGSQL_STATUS_LONG</constant> est la valeur par
défaut.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Les valeurs de retour possibles sont <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> et
<constant>PGSQL_FATAL_ERROR</constant> si <constant>PGSQL_STATUS_LONG</constant> est
spécifié. Autrement, une chaîne contenant le tag de la commande PostgreSQL
est retourné.
</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>Exemple avec <function>pg_result_status</function></title>
<programlisting role="php">
<![CDATA[
<?php
// Connexion à la base de données
$conn = pg_pconnect("dbname=publisher");
// Exécution de COPY
$result = pg_query($conn, "COPY auteurs FROM STDIN;");
// Récupération du statut
$status = pg_result_status($result);
// Détermination du statut
if ($status == PGSQL_COPY_IN)
echo "Le copiage a eu lieu.";
else
echo "Le copiage a échoué.";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Le copiage a eu lieu.
]]>
</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
-->