reference/sqlite3/sqlite3stmt/clear.xml
855bfee2f3db70d7dbb4c60c7c4a4efa567f1c60
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-

4
3
<refentry xml:id="sqlite3stmt.clear" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>SQLite3Stmt::clear</refname>
...
...
@@ -9,13 +8,22 @@
9
8

10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
-
<methodsynopsis>
11
+
<methodsynopsis role="SQLite3Stmt">
13
12
<modifier>public</modifier> <type>bool</type><methodname>SQLite3Stmt::clear</methodname>
14
-
<void />
13
+
<void/>
15
14
</methodsynopsis>
16
15
<para>
17
-
Clears all current bound parameters.
16
+
Clears all current bound parameters (sets them to &null;).
18
17
</para>
18
+
<caution>
19
+
<para>
20
+
This method needs to be used with <methodname>SQLite3Stmt::reset</methodname>.
21
+
If used alone, any call to
22
+
<methodname>SQLite3Stmt::bindValue</methodname> or
23
+
<methodname>SQLite3Stmt::bindParam</methodname> will be of no effect
24
+
and all bound parameters will have the &null; value.
25
+
</para>
26
+
</caution>
19
27
</refsect1>
20
28

21
29
<refsect1 role="parameters">
...
...
@@ -32,7 +40,6 @@
32
40
</refsect1>
33
41

34
42
</refentry>
35
-

36
43
<!-- Keep this comment at the end of the file
37
44
Local variables:
38
45
mode: sgml
39
46