sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

- Document the optional second parameter to pg_result_status()

Browse source 
# This optional second parameter has existed since at least 5.0.0, why
# was it not documented?


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@182904 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christopher Kings-Lynne 2005-03-26 08:08:35 +00:00
parent c321873f55
commit f874069b81
2 changed files with 43 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
reference/pgsql/constants.xml
View file

@ -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>

24
reference/pgsql/functions/pg-result-status.xml
View file

@ -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>