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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 288721 $ -->
<refentry xml:id="sqlite3stmt.bindparam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SQLite3Stmt::bindParam</refname>
<refpurpose>Binds a parameter to a statement variable</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SQLite3Stmt::bindParam</methodname>
<methodparam><type>string</type><parameter>sql_param</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">param</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam>
</methodsynopsis>
<para>
Binds a parameter to a statement variable.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>sql_param</parameter></term>
<listitem>
<para>
An <type>string</type> identifying the statement variable to which the
parameter should be bound.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>param</parameter></term>
<listitem>
<para>
The parameter to bind to a statement variable.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
The data type of the parameter to bind.
<itemizedlist>
<listitem>
<para>
<literal>SQLITE3_INTEGER</literal>: The value is a signed integer,
stored in 1, 2, 3, 4, 6, or 8 bytes depending on the magnitude of
the value.
</para>
</listitem>
<listitem>
<para>
<literal>SQLITE3_FLOAT</literal>: The value is a floating point
value, stored as an 8-byte IEEE floating point number.
</para>
</listitem>
<listitem>
<para>
<literal>SQLITE3_TEXT</literal>: The value is a text string, stored
using the database encoding (UTF-8, UTF-16BE or UTF-16-LE).
</para>
</listitem>
<listitem>
<para>
<literal>SQLITE3_BLOB</literal>: The value is a blob of data, stored
exactly as it was input.
</para>
</listitem>
<listitem>
<para>
<literal>SQLITE3_NULL</literal>: The value is a NULL value.
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the parameter is bound to the statement variable, &false;
on failure.
</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
-->
|
