diff --git a/reference/mysqli/functions/mysqli-stmt-reset.xml b/reference/mysqli/functions/mysqli-stmt-reset.xml new file mode 100644 index 0000000000..aabd1e2a06 --- /dev/null +++ b/reference/mysqli/functions/mysqli-stmt-reset.xml @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- $Revision: 1.1 $ --> + <refentry id="function.mysqli-stmt-reset"> + <refnamediv> + <refname>mysqli_stmt_reset</refname> + <refname>stmt->reset</refname> + <refpurpose>Resets a prepared statement</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>mysqli_stmt_reset</methodname> + <methodparam><type>object</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>reset</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + The <function>mysqli_stmt_reset</function> resets a prepared statement on client and server + to state after prepare. For now this is mainly used to reset data sent with + <function>mysqli_stmt_send_long_data</function>. + </para> + <note> + <para> + To reprepare a statement with an other query use function <function>mysqli_stmt_prepare</function>. + </para> + </note> + </refsect1> + <refsect1> + <title>Return values</title> + <para>&return.success;</para> + </refsect1> + <refsect1> + <title>See also</title> + <para> + <function>mysqli_prepare</function> + </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:"../../../../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 +--> diff --git a/reference/mysqli/reference.xml b/reference/mysqli/reference.xml index 455c98460c..f050e6a695 100644 --- a/reference/mysqli/reference.xml +++ b/reference/mysqli/reference.xml @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.14 $ --> +<!-- $Revision: 1.15 $ --> <reference id='ref.mysqli'> <title>Improved MySQL Extension</title> <titleabbrev>mysqli</titleabbrev> @@ -233,6 +233,9 @@ <listitem> <para><link linkend='function.mysqli-send-long-data'>send_long_data</link> - Sends data in chunks</para> </listitem> + <listitem> + <para><link linkend='function.mysqli-stmt-reset'>reset</link> - resets a prepared statement</para> + </listitem> <listitem> <para><link linkend='function.mysqli-stmt-store-result'>store_result</link> - Buffers complete resultset from a prepared statement</para> </listitem>