Whitespace.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@185189 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2005-04-26 14:33:31 +00:00
parent 731caacc41
commit fc86a64a2b
10 changed files with 740 additions and 740 deletions

View file

@ -1,47 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<refentry id="function.mysqli-character-set-name">
<refnamediv>
<refname>mysqli_character_set_name</refname>
<refname>mysqli->character_set_name</refname>
<refpurpose>Returns the default character set for the database connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_character_set_name</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>character_set_name</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Returns the current character set for the database connection specified by the
<parameter>link</parameter> parameter.
</para>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>The default character set for the current connection</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_client_encoding</function>&listendand;
<function>mysqli_real_escape_string</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
<!-- $Revision: 1.15 $ -->
<refentry id="function.mysqli-character-set-name">
<refnamediv>
<refname>mysqli_character_set_name</refname>
<refname>mysqli->character_set_name</refname>
<refpurpose>Returns the default character set for the database connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_character_set_name</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>character_set_name</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
Returns the current character set for the database connection specified by the
<parameter>link</parameter> parameter.
</para>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>The default character set for the current connection</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_client_encoding</function>&listendand;
<function>mysqli_real_escape_string</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
<![CDATA[
<?php
/* Open a connection */
@ -60,11 +60,11 @@ printf ("Current character set is %s\n", $charset);
$mysqli->close();
?>
]]>
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
<![CDATA[
<?php
/* Open a connection */
@ -84,16 +84,16 @@ printf ("Current character set is %s\n",$charset);
mysqli_close($link);
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
Current character set is latin1_swedish_ci
]]>
</screen>
</refsect1>
</refentry>
</screen>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,100 +1,100 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<refentry id="function.mysqli-options">
<refnamediv>
<refname>mysqli_options</refname>
<refname>mysqli->options</refname>
<refpurpose>Set options</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_options</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method)</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>options</methodname>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
<function>mysqli_options</function> can be used to set extra connect options
and affect behavior for a connection.
</para>
<para>
This function may be called multiple times to set several options.
</para>
<para>
<function>mysqli_options</function> should be called after <function>mysqli_init</function>
and before <function>mysqli_real_connect</function>.
</para>
<para>
The parameter <parameter>option</parameter> is the option that you want to set,
the <parameter>value</parameter> is the value for the option.
The parameter <parameter>option</parameter> can be one of the following values:
<table>
<title>Valid options</title>
<tgroup cols='2'>
<thead>
<row>
<entry>Name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>MYSQLI_OPT_CONNECT_TIMEOUT</constant></entry>
<entry>connection timeout in seconds</entry>
</row>
<row>
<entry><constant>MYSQLI_OPT_LOCAL_INFILE</constant></entry>
<entry>enable/disable use of <literal>LOAD LOCAL INFILE</literal></entry>
</row>
<row>
<entry><constant>MYSQLI_INIT_CMD</constant></entry>
<entry>command to execute after when connecting to MySQL server</entry>
</row>
<row>
<entry><constant>MYSQLI_READ_DEFAULT_FILE</constant></entry>
<entry>
Read options from named option file instead of <filename>my.cnf</filename>
</entry>
</row>
<row>
<entry><constant>MYSQLI_READ_DEFAULT_GROUP</constant></entry>
<entry>
Read options from the named group from <filename>my.cnf</filename>
or the file specified with <constant>MYSQL_READ_DEFAULT_FILE</constant>.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>&return.success;</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_init</function>&listendand;
<function>mysqli_real_connect</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<para>See <function>mysqli_real_connect</function>.</para>
</refsect1>
</refentry>
<!-- $Revision: 1.9 $ -->
<refentry id="function.mysqli-options">
<refnamediv>
<refname>mysqli_options</refname>
<refname>mysqli->options</refname>
<refpurpose>Set options</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_options</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method)</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>options</methodname>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
<function>mysqli_options</function> can be used to set extra connect options
and affect behavior for a connection.
</para>
<para>
This function may be called multiple times to set several options.
</para>
<para>
<function>mysqli_options</function> should be called after <function>mysqli_init</function>
and before <function>mysqli_real_connect</function>.
</para>
<para>
The parameter <parameter>option</parameter> is the option that you want to set,
the <parameter>value</parameter> is the value for the option.
The parameter <parameter>option</parameter> can be one of the following values:
<table>
<title>Valid options</title>
<tgroup cols='2'>
<thead>
<row>
<entry>Name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>MYSQLI_OPT_CONNECT_TIMEOUT</constant></entry>
<entry>connection timeout in seconds</entry>
</row>
<row>
<entry><constant>MYSQLI_OPT_LOCAL_INFILE</constant></entry>
<entry>enable/disable use of <literal>LOAD LOCAL INFILE</literal></entry>
</row>
<row>
<entry><constant>MYSQLI_INIT_CMD</constant></entry>
<entry>command to execute after when connecting to MySQL server</entry>
</row>
<row>
<entry><constant>MYSQLI_READ_DEFAULT_FILE</constant></entry>
<entry>
Read options from named option file instead of <filename>my.cnf</filename>
</entry>
</row>
<row>
<entry><constant>MYSQLI_READ_DEFAULT_GROUP</constant></entry>
<entry>
Read options from the named group from <filename>my.cnf</filename>
or the file specified with <constant>MYSQL_READ_DEFAULT_FILE</constant>.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>&return.success;</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_init</function>&listendand;
<function>mysqli_real_connect</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<para>See <function>mysqli_real_connect</function>.</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,56 +1,56 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<refentry id="function.mysqli-real-escape-string">
<refnamediv>
<refname>mysqli_real_escape_string</refname>
<refname>mysqli->real_escape_string</refname>
<refpurpose>
Escapes special characters in a string for use in a SQL statement,
taking into account the current charset of the connection
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_real_escape_string</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>escapestr</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>real_escape_string</methodname>
<methodparam><type>string</type><parameter>escapestr</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
This function is used to create a legal SQL string that you can use in a SQL statement.
The string <literal>escapestr</literal> is encoded to an escaped SQL string, taking into
account the current character set of the connection.
</para>
<para>
Characters encoded are <literal>NUL (ASCII 0), \n, \r, \, ', ", and Control-Z</literal>.
</para>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>
Returns an escaped string.
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_character_set_name</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
<!-- $Revision: 1.11 $ -->
<refentry id="function.mysqli-real-escape-string">
<refnamediv>
<refname>mysqli_real_escape_string</refname>
<refname>mysqli->real_escape_string</refname>
<refpurpose>
Escapes special characters in a string for use in a SQL statement,
taking into account the current charset of the connection
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>mysqli_real_escape_string</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>escapestr</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>real_escape_string</methodname>
<methodparam><type>string</type><parameter>escapestr</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
This function is used to create a legal SQL string that you can use in a SQL statement.
The string <literal>escapestr</literal> is encoded to an escaped SQL string, taking into
account the current character set of the connection.
</para>
<para>
Characters encoded are <literal>NUL (ASCII 0), \n, \r, \, ', ", and Control-Z</literal>.
</para>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>
Returns an escaped string.
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_character_set_name</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
@ -80,11 +80,11 @@ if ($mysqli->query("INSERT into myCity (Name) VALUES ('$city')")) {
$mysqli->close();
?>
]]>
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
<![CDATA[
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");
@ -114,17 +114,17 @@ if (mysqli_query($link, "INSERT into myCity (Name) VALUES ('$city')")) {
mysqli_close($link);
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
Error: 42000
1 Row inserted.
]]>
</screen>
</refsect1>
</refentry>
</screen>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,103 +1,103 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<refentry id="function.mysqli-stmt-bind-param">
<refnamediv>
<refname>mysqli_stmt_bind_param</refname>
<refname>stmt->bind_param</refname>
<refpurpose>Binds variables to a prepared statement as parameters</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_stmt_bind_param</methodname>
<methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
<methodparam><type>string</type><parameter>types</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>bind_param</methodname>
<methodparam><type>string</type><parameter>types</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<!-- $Revision: 1.10 $ -->
<refentry id="function.mysqli-stmt-bind-param">
<refnamediv>
<refname>mysqli_stmt_bind_param</refname>
<refname>stmt->bind_param</refname>
<refpurpose>Binds variables to a prepared statement as parameters</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_stmt_bind_param</methodname>
<methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
<methodparam><type>string</type><parameter>types</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>bind_param</methodname>
<methodparam><type>string</type><parameter>types</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
<function>mysqli_stmt_bind_param</function> is used to bind variables for the
parameter markers in the SQL statement that was passed to
<function>mysqli_prepare</function>.
The string <parameter>types</parameter> contains one or more characters which specify
the types for the corresponding bind variables
<table>
<title>Type specification chars</title>
<tgroup cols='2'>
<thead>
<row>
<entry>Character</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>i</entry>
<entry>corresponding variable has type integer</entry>
</row>
<row>
<entry>d</entry>
<entry>corresponding variable has type double</entry>
</row>
<row>
<entry>s</entry>
<entry>corresponding variable has type string</entry>
</row>
<row>
<entry>b</entry>
<entry>corresponding variable is a blob and will be send in packages</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<note>
<para>
<function>mysqli_stmt_bind_param</function> is used to bind variables for the
parameter markers in the SQL statement that was passed to
<function>mysqli_prepare</function>.
The string <parameter>types</parameter> contains one or more characters which specify
the types for the corresponding bind variables
<table>
<title>Type specification chars</title>
<tgroup cols='2'>
<thead>
<row>
<entry>Character</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>i</entry>
<entry>corresponding variable has type integer</entry>
</row>
<row>
<entry>d</entry>
<entry>corresponding variable has type double</entry>
</row>
<row>
<entry>s</entry>
<entry>corresponding variable has type string</entry>
</row>
<row>
<entry>b</entry>
<entry>corresponding variable is a blob and will be send in packages</entry>
</row>
</tbody>
</tgroup>
</table>
If data size of a variable exceeds max. allowed package size
(max_allowed_package), you have to specify <literal>b</literal> in
<parameter>types</parameter> and use
<function>mysqli_stmt_send_long_data</function> to send the data in packages.
</para>
<note>
<para>
If data size of a variable exceeds max. allowed package size
(max_allowed_package), you have to specify <literal>b</literal> in
<parameter>types</parameter> and use
<function>mysqli_stmt_send_long_data</function> to send the data in packages.
</para>
<para>
The number of variables and length of
string <parameter>types</parameter> must match the parameters in the statement.
</para>
</note>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_stmt_bind_result</function>,
<function>mysqli_stmt_execute</function>,
<function>mysqli_stmt_fetch</function>,
<function>mysqli_prepare</function>,
<function>mysqli_stmt_send_long_data</function>,
<function>mysqli_stmt_errno</function>&listendand;
<function>mysqli_stmt_error</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
The number of variables and length of
string <parameter>types</parameter> must match the parameters in the statement.
</para>
</note>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_stmt_bind_result</function>,
<function>mysqli_stmt_execute</function>,
<function>mysqli_stmt_fetch</function>,
<function>mysqli_prepare</function>,
<function>mysqli_stmt_send_long_data</function>,
<function>mysqli_stmt_errno</function>&listendand;
<function>mysqli_stmt_error</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli('localhost', 'my_user', 'my_password', 'world');
@ -132,11 +132,11 @@ printf("%d Row deleted.\n", $mysqli->affected_rows);
$mysqli->close();
?>
]]>
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
<![CDATA[
<?php
$link = mysqli_connect('localhost', 'my_user', 'my_password', 'world');
@ -171,17 +171,17 @@ printf("%d Row deleted.\n", mysqli_affected_rows($link));
mysqli_close($link);
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
1 Row inserted.
1 Row deleted.
]]>
</screen>
</refsect1>
</refentry>
</screen>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,70 +1,70 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry id="function.mysqli-stmt-bind-result">
<refnamediv>
<refname>mysqli_stmt_bind_result</refname>
<refname>stmt->bind_result</refname>
<refpurpose>Binds variables to a prepared statement for result storage</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_stmt_bind_result</methodname>
<methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>bind_result</methodname>
<methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
<function>mysqli_stmt_bind_result</function> is used to associate (bind) columns in the result
set to variables. When <function>mysqli_stmt_fetch</function> is called to fetch data, the MySQL
client/server protocol places the data for the bound columns into the specified variables
<parameter>var1, ...</parameter>.
</para>
<note>
<para>
Note that all columns must be bound prior to calling <function>mysqli_stmt_fetch</function>.
Depending on column types bound variables can silently change to the corresponding PHP type.
</para>
<para>
A column can be bound or rebound at any time, even after a result set has been partially retrieved.
The new binding takes effect the next time <function>mysqli_stmt_fetch</function> is called.
</para>
</note>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<!-- $Revision: 1.7 $ -->
<refentry id="function.mysqli-stmt-bind-result">
<refnamediv>
<refname>mysqli_stmt_bind_result</refname>
<refname>stmt->bind_result</refname>
<refpurpose>Binds variables to a prepared statement for result storage</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_stmt_bind_result</methodname>
<methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>bind_result</methodname>
<methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
<function>mysqli_stmt_bind_result</function> is used to associate (bind) columns in the result
set to variables. When <function>mysqli_stmt_fetch</function> is called to fetch data, the MySQL
client/server protocol places the data for the bound columns into the specified variables
<parameter>var1, ...</parameter>.
</para>
<note>
<para>
&return.success;
Note that all columns must be bound prior to calling <function>mysqli_stmt_fetch</function>.
Depending on column types bound variables can silently change to the corresponding PHP type.
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_stmt_bind_param</function>,
<function>mysqli_stmt_execute</function>,
<function>mysqli_stmt_fetch</function>,
<function>mysqli_prepare</function>,
<function>mysqli_stmt_prepare</function>,
<function>mysqli_stmt_init</function>,
<function>mysqli_stmt_errno</function>&listendand;
<function>mysqli_stmt_error</function>.
A column can be bound or rebound at any time, even after a result set has been partially retrieved.
The new binding takes effect the next time <function>mysqli_stmt_fetch</function> is called.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
</note>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_stmt_bind_param</function>,
<function>mysqli_stmt_execute</function>,
<function>mysqli_stmt_fetch</function>,
<function>mysqli_prepare</function>,
<function>mysqli_stmt_prepare</function>,
<function>mysqli_stmt_init</function>,
<function>mysqli_stmt_errno</function>&listendand;
<function>mysqli_stmt_error</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
@ -94,11 +94,11 @@ $mysqli->close();
?>
]]>
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
<![CDATA[
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");
@ -118,7 +118,7 @@ if ($stmt = mysqli_prepare($link, "SELECT Code, Name FROM Country ORDER BY Name
/* fetch values */
while (mysqli_stmt_fetch($stmt)) {
printf("%s %s\n", $col1, $col2);
printf("%s %s\n", $col1, $col2);
}
/* close statement */
@ -129,10 +129,10 @@ if ($stmt = mysqli_prepare($link, "SELECT Code, Name FROM Country ORDER BY Name
mysqli_close($link);
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
AFG Afghanistan
ALB Albania
@ -140,9 +140,9 @@ DZA Algeria
ASM American Samoa
AND Andorra
]]>
</screen>
</refsect1>
</refentry>
</screen>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,62 +1,62 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry id="function.mysqli-stmt-execute">
<refnamediv>
<refname>mysqli_stmt_execute</refname>
<refname>stmt->execute</refname>
<refpurpose>Executes a prepared Query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_stmt_execute</methodname>
<methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>execute</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
The <function>mysqli_stmt_execute</function> function executes a query that has been previously
prepared using the <function>mysqli_prepare</function> function represented by the
<parameter>stmt</parameter> object. When executed any parameter markers which exist will
automatically be replaced with the appropiate data.
</para>
<para>
If the statement is UPDATE, DELETE, or INSERT, the total number of affected rows can be
determined by using the <function>mysqli_stmt_affected_rows</function> function. Likewise,
if the query yields a result set the <function>mysqli_stmt_fetch</function> function is used.
</para>
<note>
<para>
When using <function>mysqli_stmt_execute</function>, the <function>mysqli_stmt_fetch</function>
function must be used to fetch the data prior to performing any additional queries.
</para>
</note>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_prepare</function>&listendand;
<function>mysqli_stmt_bind_param</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
<!-- $Revision: 1.8 $ -->
<refentry id="function.mysqli-stmt-execute">
<refnamediv>
<refname>mysqli_stmt_execute</refname>
<refname>stmt->execute</refname>
<refpurpose>Executes a prepared Query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_stmt_execute</methodname>
<methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>execute</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
The <function>mysqli_stmt_execute</function> function executes a query that has been previously
prepared using the <function>mysqli_prepare</function> function represented by the
<parameter>stmt</parameter> object. When executed any parameter markers which exist will
automatically be replaced with the appropiate data.
</para>
<para>
If the statement is UPDATE, DELETE, or INSERT, the total number of affected rows can be
determined by using the <function>mysqli_stmt_affected_rows</function> function. Likewise,
if the query yields a result set the <function>mysqli_stmt_fetch</function> function is used.
</para>
<note>
<para>
When using <function>mysqli_stmt_execute</function>, the <function>mysqli_stmt_fetch</function>
function must be used to fetch the data prior to performing any additional queries.
</para>
</note>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_prepare</function>&listendand;
<function>mysqli_stmt_bind_param</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
@ -109,11 +109,11 @@ $mysqli->query("DROP TABLE myCity");
$mysqli->close();
?>
]]>
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
<![CDATA[
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");
@ -174,9 +174,9 @@ mysqli_close($link);
Stuttgart (DEU,Baden-Wuerttemberg)
Bordeaux (FRA,Aquitaine)
]]>
</screen>
</refsect1>
</refentry>
</screen>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,82 +1,82 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry id="function.mysqli-stmt-fetch">
<refnamediv>
<refname>mysqli_stmt_fetch</refname>
<refname>stmt->fetch</refname>
<refpurpose>
Fetch results from a prepared statement into the bound variables
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>mysqli_stmt_fetch</methodname>
<methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_stmt</classname></ooclass>
<methodsynopsis>
<type>mixed</type><methodname>fetch</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
<function>mysqli_stmt_fetch</function> fetch the result from a prepared
statement into the variables bound by
<function>mysqli_stmt_bind_result</function>.
</para>
<note>
<para>
Note that all columns must be bound by the application before calling
<function>mysqli_stmt_fetch</function>.
</para>
</note>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<table>
&reftitle.returnvalues;
<tgroup cols='2'>
<thead>
<row>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&true;</entry>
<entry>Success. Data has been fetched</entry>
</row>
<row>
<entry>&false;</entry>
<entry>Error occured</entry>
</row>
<row>
<entry><literal>&null;</literal></entry>
<entry>No more rows/data exists</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_prepare</function>,
<function>mysqli_stmt_errno</function>,
<function>mysqli_stmt_error</function>&listendand;
<function>mysqli_stmt_bind_result</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
<!-- $Revision: 1.7 $ -->
<refentry id="function.mysqli-stmt-fetch">
<refnamediv>
<refname>mysqli_stmt_fetch</refname>
<refname>stmt->fetch</refname>
<refpurpose>
Fetch results from a prepared statement into the bound variables
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>mysqli_stmt_fetch</methodname>
<methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_stmt</classname></ooclass>
<methodsynopsis>
<type>mixed</type><methodname>fetch</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
<function>mysqli_stmt_fetch</function> fetch the result from a prepared
statement into the variables bound by
<function>mysqli_stmt_bind_result</function>.
</para>
<note>
<para>
Note that all columns must be bound by the application before calling
<function>mysqli_stmt_fetch</function>.
</para>
</note>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<table>
&reftitle.returnvalues;
<tgroup cols='2'>
<thead>
<row>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&true;</entry>
<entry>Success. Data has been fetched</entry>
</row>
<row>
<entry>&false;</entry>
<entry>Error occured</entry>
</row>
<row>
<entry><literal>&null;</literal></entry>
<entry>No more rows/data exists</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_prepare</function>,
<function>mysqli_stmt_errno</function>,
<function>mysqli_stmt_error</function>&listendand;
<function>mysqli_stmt_bind_result</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
@ -110,11 +110,11 @@ if ($stmt = $mysqli->prepare($query)) {
$mysqli->close();
?>
]]>
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
<![CDATA[
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");
@ -148,10 +148,10 @@ if ($stmt = mysqli_prepare($link, $query)) {
mysqli_close($link);
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
Rockford (USA)
Tallahassee (USA)
@ -159,9 +159,9 @@ Salinas (USA)
Santa Clarita (USA)
Springfield (USA)
]]>
</screen>
</refsect1>
</refentry>
</screen>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,45 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-stmt-param-count">
<refnamediv>
<refname>mysqli_stmt_param_count</refname>
<refname>stmt->param_count</refname>
<refpurpose>Returns the number of parameter for the given statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_stmt_param_count</methodname>
<methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli_stmt</classname></ooclass>
<fieldsynopsis><type>int</type><varname>param_count</varname></fieldsynopsis>
</classsynopsis>
<para>
<function>mysqli_stmt_param_count</function> returns the number of parameter
markers present in the prepared statement.
</para>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>
returns an integer representing the number of parameters.
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_prepare</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-stmt-param-count">
<refnamediv>
<refname>mysqli_stmt_param_count</refname>
<refname>stmt->param_count</refname>
<refpurpose>Returns the number of parameter for the given statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_stmt_param_count</methodname>
<methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>mysqli_stmt</classname></ooclass>
<fieldsynopsis><type>int</type><varname>param_count</varname></fieldsynopsis>
</classsynopsis>
<para>
<function>mysqli_stmt_param_count</function> returns the number of parameter
markers present in the prepared statement.
</para>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>
returns an integer representing the number of parameters.
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_prepare</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
@ -63,11 +63,11 @@ if ($stmt = $mysqli->prepare("SELECT Name FROM Country WHERE Name=? OR Code=?"))
$mysqli->close();
?>
]]>
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
<![CDATA[
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");
@ -91,16 +91,16 @@ if ($stmt = mysqli_prepare($link, "SELECT Name FROM Country WHERE Name=? OR Code
mysqli_close($link);
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
Statement has 2 markers.
]]>
</screen>
</refsect1>
</refentry>
</screen>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,78 +1,78 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry id="function.mysqli-stmt-result-metadata">
<refnamediv>
<refname>mysqli_stmt_result_metadata</refname>
<refpurpose>Returns result set metadata from a prepared statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>mysqli_stmt_result_metadata</methodname>
<methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_stmt</classname></ooclass>
<methodsynopsis>
<type>mixed</type><methodname>result_metadata</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
If a statement passed to <function>mysqli_prepare</function> is one that produces
a result set, <function>mysqli_stmt_result_metadata</function> returns the result object
that can be used to process the meta information such as total number of fields
and individual field information.
</para>
<note>
<para>This result set pointer can be passed as an argument to any of the
field-based functions that process result set metadata, such as:
<itemizedlist>
<listitem><para><function>mysqli_num_fields</function></para></listitem>
<listitem><para><function>mysqli_fetch_field</function></para></listitem>
<listitem><para><function>mysqli_fetch_field_direct</function></para></listitem>
<listitem><para><function>mysqli_fetch_fields</function></para></listitem>
<listitem><para><function>mysqli_field_count</function></para></listitem>
<listitem><para><function>mysqli_field_seek</function></para></listitem>
<listitem><para><function>mysqli_field_tell</function></para></listitem>
<listitem><para><function>mysqli_free_result</function></para></listitem>
</itemizedlist>
</para>
</note>
<para>
The result set structure should be freed when you are done with it,
which you can do by passing it to <function>mysqli_free_result</function>
</para>
<note>
<para>
The result set returned by <function>mysqli_stmt_result_metadata</function> contains only
metadata. It does not contain any row results. The rows are obtained by using the
statement handle with <function>mysqli_stmt_fetch</function>.
</para>
</note>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>
<function>mysqli_stmt_result_metadata</function> returns a result object or &false; if
an error occured.
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_prepare</function>&listendand;
<function>mysqli_free_result</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<para>
<example>
<title>Object oriented style</title>
<programlisting role='php'>
<!-- $Revision: 1.8 $ -->
<refentry id="function.mysqli-stmt-result-metadata">
<refnamediv>
<refname>mysqli_stmt_result_metadata</refname>
<refpurpose>Returns result set metadata from a prepared statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>mysqli_stmt_result_metadata</methodname>
<methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method):</para>
<classsynopsis>
<ooclass><classname>mysqli_stmt</classname></ooclass>
<methodsynopsis>
<type>mixed</type><methodname>result_metadata</methodname>
<void />
</methodsynopsis>
</classsynopsis>
<para>
If a statement passed to <function>mysqli_prepare</function> is one that produces
a result set, <function>mysqli_stmt_result_metadata</function> returns the result object
that can be used to process the meta information such as total number of fields
and individual field information.
</para>
<note>
<para>This result set pointer can be passed as an argument to any of the
field-based functions that process result set metadata, such as:
<itemizedlist>
<listitem><para><function>mysqli_num_fields</function></para></listitem>
<listitem><para><function>mysqli_fetch_field</function></para></listitem>
<listitem><para><function>mysqli_fetch_field_direct</function></para></listitem>
<listitem><para><function>mysqli_fetch_fields</function></para></listitem>
<listitem><para><function>mysqli_field_count</function></para></listitem>
<listitem><para><function>mysqli_field_seek</function></para></listitem>
<listitem><para><function>mysqli_field_tell</function></para></listitem>
<listitem><para><function>mysqli_free_result</function></para></listitem>
</itemizedlist>
</para>
</note>
<para>
The result set structure should be freed when you are done with it,
which you can do by passing it to <function>mysqli_free_result</function>
</para>
<note>
<para>
The result set returned by <function>mysqli_stmt_result_metadata</function> contains only
metadata. It does not contain any row results. The rows are obtained by using the
statement handle with <function>mysqli_stmt_fetch</function>.
</para>
</note>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>
<function>mysqli_stmt_result_metadata</function> returns a result object or &false; if
an error occured.
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_prepare</function>&listendand;
<function>mysqli_free_result</function>.
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<para>
<example>
<title>Object oriented style</title>
<programlisting role='php'>
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "test");
@ -100,11 +100,11 @@ $result->close();
$mysqli->close();
?>
]]>
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role='php'>
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role='php'>
<![CDATA[
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "test");
@ -132,11 +132,11 @@ mysqli_free_result($result);
mysqli_close($link);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,53 +1,53 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry id="function.mysqli-stmt-send-long-data">
<refnamediv>
<refname>mysqli_stmt_send_long_data</refname>
<refname>stmt->send_long_data</refname>
<refpurpose>Send data in blocks</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_stmt_send_long_data</methodname>
<methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
<methodparam><type>int</type><parameter>param_nr</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method)</para>
<classsynopsis>
<ooclass><classname>mysqli_stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>send_long_data</methodname>
<methodparam><type>int</type><parameter>param_nr</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Allows to send parameter data to the server in pieces (or chunks), e.g. if the
size of a blob exceeds the size of <literal>max_allowed_packet</literal>.
This function can be called multiple times to send the parts of a character or
binary data value for a column, which must be one of the TEXT or BLOB datatypes.
</para>
<para>
<parameter>param_nr</parameter> indicates which parameter to associate the data with.
Parameters are numbered beginning with 0.
<parameter>data</parameter> is a string containing data to be sent.
</para>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>&return.success;</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_prepare</function>&listendand;
<function>mysqli_stmt_bind_param</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.6 $ -->
<refentry id="function.mysqli-stmt-send-long-data">
<refnamediv>
<refname>mysqli_stmt_send_long_data</refname>
<refname>stmt->send_long_data</refname>
<refpurpose>Send data in blocks</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_stmt_send_long_data</methodname>
<methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
<methodparam><type>int</type><parameter>param_nr</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method)</para>
<classsynopsis>
<ooclass><classname>mysqli_stmt</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>send_long_data</methodname>
<methodparam><type>int</type><parameter>param_nr</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Allows to send parameter data to the server in pieces (or chunks), e.g. if the
size of a blob exceeds the size of <literal>max_allowed_packet</literal>.
This function can be called multiple times to send the parts of a character or
binary data value for a column, which must be one of the TEXT or BLOB datatypes.
</para>
<para>
<parameter>param_nr</parameter> indicates which parameter to associate the data with.
Parameters are numbered beginning with 0.
<parameter>data</parameter> is a string containing data to be sent.
</para>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>&return.success;</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>mysqli_prepare</function>&listendand;
<function>mysqli_stmt_bind_param</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: