doc-zh/reference/pgsql/functions/pg-result-status.xml at master · php/doc-zh · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3c6c95fcfd7d9eaa603df40327693ea8dff89d53 Maintainer: dallas Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.58 -->
<refentry xml:id="function.pg-result-status" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_result_status</refname>
  <refpurpose>
   获得查询结果的状态
  </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> 返回 <classname>PgSql\Result</classname> 实例的状态，或者与 result 相关的 PostgreSQL 命令完成标记。
  </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>
       要么指定 <constant>PGSQL_STATUS_LONG</constant> 返回 <parameter>result</parameter> 的数字状态，要么指定 <constant>PGSQL_STATUS_STRING</constant>
       返回 <parameter>result</parameter> 的命令标记。如果未指定，默认是 <constant>PGSQL_STATUS_LONG</constant>。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   如果指定 <constant>PGSQL_STATUS_LONG</constant>，可能返回的值是
   <constant>PGSQL_EMPTY_QUERY</constant>、<constant>PGSQL_COMMAND_OK</constant>、<constant>PGSQL_TUPLES_OK</constant>、<constant>PGSQL_TUPLES_CHUNK</constant>、<constant>PGSQL_COPY_OUT</constant>、<constant>PGSQL_COPY_IN</constant>、<constant>PGSQL_BAD_RESPONSE</constant>、<constant>PGSQL_NONFATAL_ERROR</constant>
   和 <constant>PGSQL_FATAL_ERROR</constant>。否则，返回包含 PostgreSQL 命令标记的 <type>string</type>。
  </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><function>pg_result_status</function> 示例</title>
    <programlisting role="php">
<![CDATA[
<?php

// Connect to the database
$conn = pg_pconnect("dbname=publisher");

// Execute a COPY
$result = pg_query($conn, "COPY authors FROM STDIN;");

// Get the result status
$status = pg_result_status($result);

// Determine status
if ($status == PGSQL_COPY_IN)
   echo "Copy began.";
else
   echo "Copy failed.";

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Copy began.
]]>
    </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
-->