reference/pdo/pdostatement/closecursor.xml
082ddc19f53e6e254010de1a1fbbe485ff744ec1
082ddc19f53e6e254010de1a1fbbe485ff744ec1
...
...
@@ -4,18 +4,18 @@
4
4
<refnamediv>
5
5
<refname>PDOStatement::closeCursor</refname>
6
6
<refpurpose>
7
-
Closes the cursor, enabling the statement to be executed again.
7
+
Closes the cursor, enabling the statement to be executed again
8
8
</refpurpose>
9
9
</refnamediv>
10
10
<refsect1 role="description">
11
11
&reftitle.description;
12
-
<methodsynopsis>
13
-
<type>bool</type><methodname>PDOStatement::closeCursor</methodname>
12
+
<methodsynopsis role="PDOStatement">
13
+
<modifier>public</modifier> <type>bool</type><methodname>PDOStatement::closeCursor</methodname>
14
14
<void/>
15
15
</methodsynopsis>
16
16
17
17
<para>
18
-
<function>PDOStatement::closeCursor</function> frees up the connection
18
+
<methodname>PDOStatement::closeCursor</methodname> frees up the connection
19
19
to the server so that other SQL statements may be issued, but leaves the
20
20
statement in a state that enables it to be executed again.
21
21
</para>
...
...
@@ -26,7 +26,7 @@
26
26
the problem may manifest itself in an out-of-sequence error.
27
27
</para>
28
28
<para>
29
-
<function>PDOStatement::closeCursor</function> is implemented either as an
29
+
<methodname>PDOStatement::closeCursor</methodname> is implemented either as an
30
30
optional driver specific method (allowing for maximum efficiency), or as
31
31
the generic PDO fallback if no driver specific function is installed.
32
32
The PDO generic fallback is semantically the same as writing the following
...
...
@@ -44,7 +44,11 @@ do {
44
44
]]>
45
45
</programlisting>
46
46
</para>
47
+
</refsect1>
47
48
49
+
<refsect1 role="parameters">
50
+
&reftitle.parameters;
51
+
&no.function.parameters;
48
52
</refsect1>
49
53
50
54
<refsect1 role="returnvalues">
...
...
@@ -54,17 +58,22 @@ do {
54
58
</para>
55
59
</refsect1>
56
60
61
+
<refsect1 role="errors">
62
+
&reftitle.errors;
63
+
&pdo.errors;
64
+
</refsect1>
65
+
57
66
<refsect1 role="examples">
58
67
&reftitle.examples;
59
68
<para>
60
69
<example>
61
-
<title>A <function>PDOStatement::closeCursor</function> example</title>
70
+
<title>A <methodname>PDOStatement::closeCursor</methodname> example</title>
62
71
<para>
63
72
In the following example, the <varname>$stmt</varname> PDOStatement
64
73
object returns multiple rows but the application fetches only the first
65
74
row, leaving the PDOStatement object in a state of having unfetched rows.
66
75
To ensure that the application will work with all database drivers, the
67
-
author inserts a call to <function>PDOStatement::closeCursor</function>
76
+
author inserts a call to <methodname>PDOStatement::closeCursor</methodname>
68
77
on <varname>$stmt</varname> before executing the
69
78
<varname>$otherStmt</varname> PDOStatement object.
70
79
</para>
...
...
@@ -99,13 +108,12 @@ $otherStmt->execute();
99
108
&reftitle.seealso;
100
109
<para>
101
110
<simplelist>
102
-
<member><function>PDOStatement::execute</function></member>
111
+
<member><methodname>PDOStatement::execute</methodname></member>
103
112
</simplelist>
104
113
</para>
105
114
</refsect1>
106
115
107
116
</refentry>
108
-
109
117
<!-- Keep this comment at the end of the file
110
118
Local variables:
111
119
mode: sgml
112
120