chriskl Sat Mar 26 03:08:35 2005 EDT
Modified files:
/phpdoc/en/reference/pgsql constants.xml
/phpdoc/en/reference/pgsql/functions pg-result-status.xml
Log:
- Document the optional second parameter to pg_result_status()
# This optional second parameter has existed since at least 5.0.0, why
# was it not documented?
http://cvs.php.net/diff.php/phpdoc/en/reference/pgsql/constants.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/pgsql/constants.xml
diff -u phpdoc/en/reference/pgsql/constants.xml:1.4
phpdoc/en/reference/pgsql/constants.xml:1.5
--- phpdoc/en/reference/pgsql/constants.xml:1.4 Tue Mar 22 22:11:05 2005
+++ phpdoc/en/reference/pgsql/constants.xml Sat Mar 26 03:08:34 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<section id="pgsql.constants">
&reftitle.constants;
&extension.constants;
@@ -424,6 +424,30 @@
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>
+ <constant>PGSQL_STATUS_LONG</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>PGSQL_STATUS_STRING</constant>
+ (<type>integer</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+
+
</variablelist>
</section>
http://cvs.php.net/diff.php/phpdoc/en/reference/pgsql/functions/pg-result-status.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/pgsql/functions/pg-result-status.xml
diff -u phpdoc/en/reference/pgsql/functions/pg-result-status.xml:1.5
phpdoc/en/reference/pgsql/functions/pg-result-status.xml:1.6
--- phpdoc/en/reference/pgsql/functions/pg-result-status.xml:1.5 Fri Mar
11 11:03:26 2005
+++ phpdoc/en/reference/pgsql/functions/pg-result-status.xml Sat Mar 26
03:08:35 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.58 -->
<refentry id='function.pg-result-status'>
<refnamediv>
@@ -12,15 +12,27 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>int</type><methodname>pg_result_status</methodname>
+ <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> returns status of result
- resource. Possible return values are PGSQL_EMPTY_QUERY,
- PGSQL_COMMAND_OK, PGSQL_TUPLES_OK, PGSQL_COPY_TO,
- PGSQL_COPY_FROM, PGSQL_BAD_RESPONSE, PGSQL_NONFATAL_ERROR and
- PGSQL_FATAL_ERROR.
+ resource, or the command tag associated with the result. Possible values
+ of <parameter>type</parameter> are <literal>PGSQL_STATUS_LONG</literal>
+ or <literal>PGSQL_STATUS_STRING</literal>. The default is
+ <literal>PGSQL_STATUS_LONG</literal>.
+ </para>
+ <para>
+ Possible return values are <literal>PGSQL_EMPTY_QUERY</literal>,
+ <literal>PGSQL_COMMAND_OK</literal>, <literal>PGSQL_TUPLES_OK</literal>,
<literal>PGSQL_COPY_TO</literal>,
+ <literal>PGSQL_COPY_FROM</literal>, <literal>PGSQL_BAD_RESPONSE</literal>,
<literal>PGSQL_NONFATAL_ERROR</literal> and
+ <literal>PGSQL_FATAL_ERROR</literal> if
<literal>PGSQL_STATUS_LONG</literal> is
+ specified.
+ </para>
+ <para>
+ When <literal>PGSQL_STATUS_STRING</literal> is used, then the returned
+ value is the command completion tag from PostgreSQL.
</para>
</refsect1>
