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
141
142
143
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysqli-stmt.attr-set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mysqli_stmt::attr_set</refname>
<refname>mysqli_stmt_attr_set</refname>
<refpurpose>Used to modify the behavior of a prepared statement</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="mysqli_stmt">
<modifier>public</modifier> <type>bool</type><methodname>mysqli_stmt::attr_set</methodname>
<methodparam><type>int</type><parameter>attribute</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_stmt_attr_set</methodname>
<methodparam><type>mysqli_stmt</type><parameter>statement</parameter></methodparam>
<methodparam><type>int</type><parameter>attribute</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Used to modify the behavior of a prepared statement. This function may be
called multiple times to set several attributes.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>&mysqli.stmt.description;<varlistentry>
<term><parameter>attribute</parameter></term>
<listitem>
<para>
The attribute that you want to set. It can have one of the following values:
<table xml:id="mysqli-stmt.attr-set.parameters">
<title>Attribute values</title>
<tgroup cols="2">
<thead>
<row>
<entry>Character</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH</entry>
<entry>
Setting to &true; causes <function>mysqli_stmt_store_result</function> to
update the metadata <literal>MYSQL_FIELD->max_length</literal> value.
</entry>
</row>
<row>
<entry>MYSQLI_STMT_ATTR_CURSOR_TYPE</entry>
<entry>
Type of cursor to open for statement when <function>mysqli_stmt_execute</function>
is invoked. <parameter>value</parameter> can be <constant>MYSQLI_CURSOR_TYPE_NO_CURSOR</constant>
(the default) or <constant>MYSQLI_CURSOR_TYPE_READ_ONLY</constant>.
</entry>
</row>
<row>
<entry>MYSQLI_STMT_ATTR_PREFETCH_ROWS</entry>
<entry>
Number of rows to fetch from server at a time when using a cursor.
<parameter>value</parameter> can be in the range from 1 to the maximum
value of unsigned long. The default is 1.
Removed as of PHP 8.4.0.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
If you use the <constant>MYSQLI_STMT_ATTR_CURSOR_TYPE</constant> option with
<constant>MYSQLI_CURSOR_TYPE_READ_ONLY</constant>, a cursor is opened for the
statement when you invoke <function>mysqli_stmt_execute</function>. If there
is already an open cursor from a previous <function>mysqli_stmt_execute</function> call,
it closes the cursor before opening a new one. <function>mysqli_stmt_reset</function>
also closes any open cursor before preparing the statement for re-execution.
<function>mysqli_stmt_free_result</function> closes any open cursor.
</para>
<para>
If you open a cursor for a prepared statement, <function>mysqli_stmt_store_result</function>
is unnecessary.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>The value to assign to the attribute.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
&mysqli.conditionalexception;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&url.mysql.docs.stmt-attr-set;">Connector/MySQL mysql_stmt_attr_set()</link></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
-->
|
