reference/pgsql/functions/pg-result-status.xml
c2eca73ef79ebe78cebb34053e41b565af504c4f
...
...
@@ -1,7 +1,7 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
3
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.58 -->
4
-
<refentry xml:id='function.pg-result-status' xmlns="http://docbook.org/ns/docbook">
4
+
<refentry xml:id="function.pg-result-status" xmlns="http://docbook.org/ns/docbook">
5
5
<refnamediv>
6
6
<refname>pg_result_status</refname>
7
7
<refpurpose>
...
...
@@ -12,13 +12,13 @@
12
12
<refsect1 role="description">
13
13
&reftitle.description;
14
14
<methodsynopsis>
15
-
<type>mixed</type><methodname>pg_result_status</methodname>
16
-
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
17
-
<methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer>PGSQL_STATUS_LONG</initializer></methodparam>
15
+
<type class="union"><type>string</type><type>int</type></type><methodname>pg_result_status</methodname>
16
+
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
17
+
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>PGSQL_STATUS_LONG</constant></initializer></methodparam>
18
18
</methodsynopsis>
19
19
<para>
20
-
<function>pg_result_status</function> returns the status of a result
21
-
resource, or the PostgreSQL command completion tag associated with the result
20
+
<function>pg_result_status</function> returns the status of the <classname>PgSql\Result</classname> instance,
21
+
or the PostgreSQL command completion tag associated with the result
22
22
</para>
23
23
</refsect1>
24
24

...
...
@@ -29,15 +29,11 @@
29
29
<varlistentry>
30
30
<term><parameter>result</parameter></term>
31
31
<listitem>
32
-
<para>
33
-
PostgreSQL query result resource, returned by <function>pg_query</function>,
34
-
<function>pg_query_params</function> or <function>pg_execute</function>
35
-
(among others).
36
-
</para>
32
+
&pgsql.parameter.result;
37
33
</listitem>
38
34
</varlistentry>
39
35
<varlistentry>
40
-
<term><parameter>type</parameter></term>
36
+
<term><parameter>mode</parameter></term>
41
37
<listitem>
42
38
<para>
43
39
Either <constant>PGSQL_STATUS_LONG</constant> to return the numeric status
...
...
@@ -62,6 +58,23 @@
62
58
</para>
63
59
</refsect1>
64
60

61
+
<refsect1 role="changelog">
62
+
&reftitle.changelog;
63
+
<informaltable>
64
+
<tgroup cols="2">
65
+
<thead>
66
+
<row>
67
+
<entry>&Version;</entry>
68
+
<entry>&Description;</entry>
69
+
</row>
70
+
</thead>
71
+
<tbody>
72
+
&pgsql.changelog.result-object;
73
+
</tbody>
74
+
</tgroup>
75
+
</informaltable>
76
+
</refsect1>
77
+

65
78
<refsect1 role="examples">
66
79
&reftitle.examples;
67
80
<para>
...
...
@@ -108,7 +121,6 @@ Copy began.
108
121
</para>
109
122
</refsect1>
110
123
</refentry>
111
-

112
124
<!-- Keep this comment at the end of the file
113
125
Local variables:
114
126
mode: sgml
115
127