cvs: phpdoc /en language-snippets.ent /en/reference/mysqli/functions mysqli-affected-rows.xml mysqli-autocommit.xml mysqli-bind-param.xml
mysqli-bind-result.xml mysqli-change-user.xml mysqli-character-set-name.xml mysqli-client-encoding.xml mysqli-close.xml mysqli-commit.xml
mysqli-connect-errno.xml mysqli-connect-error.xml mysqli-connect.xml mysqli-data-seek.xml mysqli-debug.xml mysqli-disable-reads-from-master.xml
mysqli-disable-rpl-parse.xml mysqli-dump-debug-info.xml mysqli-embedded-connect.xml mysqli-enable-reads-from-master.xml mysqli-enable-rpl-parse.xml
mysqli-errno.xml mysqli-error.xml mysqli-escape-string.xml mysqli-execute.xml mysqli-fetch-array.xml mysqli-fetch-assoc.xml
mysqli-fetch-field-direct.xml mysqli-fetch-field.xml mysqli-fetch-fields.xml mysqli-fetch-lengths.xml mysqli-fetch-object.xml mysqli-fetch-row.xml
mysqli-fetch.xml mysqli-field-count.xml mysqli-field-seek.xml mysqli-field-tell.xml mysqli-free-result.xml mysqli-get-client-info.xml mysqli!
-get-client-version.xml mysqli-get-host-info.xml mysqli-get-metadata.xml mysqli-get-proto-info.xml mysqli-get-server-info.xml
mysqli-get-server-version.xml mysqli-info.xml mysqli-init.xml mysqli-insert-id.xml mysqli-kill.xml mysqli-master-query.xml mysqli-more-results.xml
mysqli-multi-query.xml mysqli-next-result.xml mysqli-num-fields.xml mysqli-num-rows.xml mysqli-options.xml mysqli-param-count.xml mysqli-ping.xml
mysqli-prepare.xml mysqli-query.xml mysqli-real-connect.xml mysqli-real-escape-string.xml mysqli-real-query.xml mysqli-report.xml mysqli-rollback.xml
mysqli-rpl-parse-enabled.xml mysqli-rpl-probe.xml mysqli-rpl-query-type.xml mysqli-select-db.xml mysqli-send-long-data.xml mysqli-send-query.xml
mysqli-server-end.xml mysqli-server-init.xml mysqli-set-charset.xml mysqli-set-opt.xml mysqli-sqlstate.xml mysqli-ssl-set.xml mysqli-stat.xml
mysqli-stmt-affected-rows.xml mysqli-stmt-bind-param.xml mysqli-stmt-bind-result.xml mysqli-stmt-close.xml mysqli-stmt-data-seek.xml!
mysqli-stmt-errno.xml mysqli-stmt-error.xml mysqli-stmt-execute.xml mysqli-stmt-fetch.xml mysqli-stmt-free-result.xml mysqli-stmt-init.xml
mysqli-stmt-num-rows.xml mysqli-stmt-param-count.xml mysqli-stmt-prepare.xml mysqli-stmt-reset.xml mysqli-stmt-result-metadata.xml
mysqli-stmt-send-long-data.xml mysqli-stmt-sqlstate.xml

From:	Mehdi Achour	Date:	Sun, 28 Jan 2007 04:25:58 +0000
Subject:	cvs: phpdoc /en language-snippets.ent /en/reference/mysqli/functions mysqli-affected-rows.xml mysqli-autocommit.xml mysqli-bind-param.xml mysqli-bind-result.xml mysqli-change-user.xml mysqli-character-set-name.xml mysqli-client-encoding.xml mysqli-close.xml mysqli-commit.xml mysqli-connect-errno.xml mysqli-connect-error.xml mysqli-connect.xml mysqli-data-seek.xml mysqli-debug.xml mysqli-disable-reads-from-master.xml mysqli-disable-rpl-parse.xml mysqli-dump-debug-info.xml mysqli-embedded-connect.xml mysqli-enable-reads-from-master.xml mysqli-enable-rpl-parse.xml mysqli-errno.xml mysqli-error.xml mysqli-escape-string.xml mysqli-execute.xml mysqli-fetch-array.xml mysqli-fetch-assoc.xml mysqli-fetch-field-direct.xml mysqli-fetch-field.xml mysqli-fetch-fields.xml mysqli-fetch-lengths.xml mysqli-fetch-object.xml mysqli-fetch-row.xml mysqli-fetch.xml mysqli-field-count.xml mysqli-field-seek.xml mysqli-field-tell.xml mysqli-free-result.xml mysqli-get-client-info.xml mysqli! -get-client-version.xml mysqli-get-host-info.xml mysqli-get-metadata.xml mysqli-get-proto-info.xml mysqli-get-server-info.xml mysqli-get-server-version.xml mysqli-info.xml mysqli-init.xml mysqli-insert-id.xml mysqli-kill.xml mysqli-master-query.xml mysqli-more-results.xml mysqli-multi-query.xml mysqli-next-result.xml mysqli-num-fields.xml mysqli-num-rows.xml mysqli-options.xml mysqli-param-count.xml mysqli-ping.xml mysqli-prepare.xml mysqli-query.xml mysqli-real-connect.xml mysqli-real-escape-string.xml mysqli-real-query.xml mysqli-report.xml mysqli-rollback.xml mysqli-rpl-parse-enabled.xml mysqli-rpl-probe.xml mysqli-rpl-query-type.xml mysqli-select-db.xml mysqli-send-long-data.xml mysqli-send-query.xml mysqli-server-end.xml mysqli-server-init.xml mysqli-set-charset.xml mysqli-set-opt.xml mysqli-sqlstate.xml mysqli-ssl-set.xml mysqli-stat.xml mysqli-stmt-affected-rows.xml mysqli-stmt-bind-param.xml mysqli-stmt-bind-result.xml mysqli-stmt-close.xml mysqli-stmt-data-seek.xml! mysqli-stmt-errno.xml mysqli-stmt-error.xml mysqli-stmt-execute.xml mysqli-stmt-fetch.xml mysqli-stmt-free-result.xml mysqli-stmt-init.xml mysqli-stmt-num-rows.xml mysqli-stmt-param-count.xml mysqli-stmt-prepare.xml mysqli-stmt-reset.xml mysqli-stmt-result-metadata.xml mysqli-stmt-send-long-data.xml mysqli-stmt-sqlstate.xml
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969375052@lists.php.net to get a copy of this message

didou Sun Jan 28 04:25:58 2007 UTC Modified files: /phpdoc/en language-snippets.ent /phpdoc/en/reference/mysqli/functions mysqli-affected-rows.xml mysqli-autocommit.xml mysqli-bind-param.xml mysqli-bind-result.xml mysqli-change-user.xml mysqli-character-set-name.xml mysqli-client-encoding.xml mysqli-close.xml mysqli-commit.xml mysqli-connect-errno.xml mysqli-connect-error.xml mysqli-connect.xml mysqli-data-seek.xml mysqli-debug.xml mysqli-disable-reads-from-master.xml mysqli-disable-rpl-parse.xml mysqli-dump-debug-info.xml mysqli-embedded-connect.xml mysqli-enable-reads-from-master.xml mysqli-enable-rpl-parse.xml mysqli-errno.xml mysqli-error.xml mysqli-escape-string.xml mysqli-execute.xml mysqli-fetch-array.xml mysqli-fetch-assoc.xml mysqli-fetch-field-direct.xml mysqli-fetch-field.xml mysqli-fetch-fields.xml mysqli-fetch-lengths.xml mysqli-fetch-object.xml mysqli-fetch-row.xml mysqli-fetch.xml mysqli-field-count.xml mysqli-field-seek.xml mysqli-field-tell.xml mysqli-free-result.xml mysqli-get-client-info.xml mysqli-get-client-version.xml mysqli-get-host-info.xml mysqli-get-metadata.xml mysqli-get-proto-info.xml mysqli-get-server-info.xml mysqli-get-server-version.xml mysqli-info.xml mysqli-init.xml mysqli-insert-id.xml mysqli-kill.xml mysqli-master-query.xml mysqli-more-results.xml mysqli-multi-query.xml mysqli-next-result.xml mysqli-num-fields.xml mysqli-num-rows.xml mysqli-options.xml mysqli-param-count.xml mysqli-ping.xml mysqli-prepare.xml mysqli-query.xml mysqli-real-connect.xml mysqli-real-escape-string.xml mysqli-real-query.xml mysqli-report.xml mysqli-rollback.xml mysqli-rpl-parse-enabled.xml mysqli-rpl-probe.xml mysqli-rpl-query-type.xml mysqli-select-db.xml mysqli-send-long-data.xml mysqli-send-query.xml mysqli-server-end.xml mysqli-server-init.xml mysqli-set-charset.xml mysqli-set-opt.xml mysqli-sqlstate.xml mysqli-ssl-set.xml mysqli-stat.xml mysqli-stmt-affected-rows.xml mysqli-stmt-bind-param.xml mysqli-stmt-bind-result.xml mysqli-stmt-close.xml mysqli-stmt-data-seek.xml mysqli-stmt-errno.xml mysqli-stmt-error.xml mysqli-stmt-execute.xml mysqli-stmt-fetch.xml mysqli-stmt-free-result.xml mysqli-stmt-init.xml mysqli-stmt-num-rows.xml mysqli-stmt-param-count.xml mysqli-stmt-prepare.xml mysqli-stmt-reset.xml mysqli-stmt-result-metadata.xml mysqli-stmt-send-long-data.xml mysqli-stmt-sqlstate.xml mysqli-stmt-store-result.xml mysqli-store-result.xml mysqli-thread-id.xml mysqli-thread-safe.xml mysqli-use-result.xml mysqli-warning-count.xml Log: ref.mysqli: switch to new style

http://cvs.php.net/viewvc.cgi/phpdoc/en/language-snippets.ent?r1=1.187&r2=1.188&diff_format=u Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.187 phpdoc/en/language-snippets.ent:1.188 --- phpdoc/en/language-snippets.ent:1.187 Sat Jan 27 16:51:44 2007 +++ phpdoc/en/language-snippets.ent Sun Jan 28 04:25:56 2007 @@ -1,4 +1,4 @@ - +  @@ -509,6 +509,20 @@ returned by <function>fbsql_query</function> or <function>fbsql_db_query</function>.</para></listitem></varlistentry>'> + +<!ENTITY mysqli.result.description '<varlistentry><term><parameter> +result</parameter></term><listitem><para>Procedural style only: A result set +isentifier returned by <function>mysqli_query</function>, <function>mysqli_store_result</function> +or <function>mysqli_use_result</function>.</para></listitem></varlistentry>'> +<!ENTITY mysqli.link.description '<varlistentry><term><parameter> +link</parameter></term><listitem><para>Procedural style only: A link identifier +returned by <function>mysqli_connect</function> or <function>mysqli_init</function> +</para></listitem></varlistentry>'> +<!ENTITY mysqli.stmt.description '<varlistentry><term><parameter> +stmt</parameter></term><listitem><para>Procedural style only: A statement identifier +returned by <function>mysqli_stmt_init</function>.</para></listitem></varlistentry>'> + +  <!ENTITY note.apache.nsapi-module '<note><para>As of PHP 4.3.3 you can use this function with the <link linkend="ref.nsapi">NSAPI server module</link> in Netscape/iPlanet/SunONE http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mysqli/functions/mysqli-affected-rows.xml?r1=1.22&r2=1.23&diff_format=u Index: phpdoc/en/reference/mysqli/functions/mysqli-affected-rows.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-affected-rows.xml:1.22 phpdoc/en/reference/mysqli/functions/mysqli-affected-rows.xml:1.23 --- phpdoc/en/reference/mysqli/functions/mysqli-affected-rows.xml:1.22 Sat Jan 27 17:37:35 2007 +++ phpdoc/en/reference/mysqli/functions/mysqli-affected-rows.xml Sun Jan 28 04:25:57 2007 @@ -1,13 +1,14 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.mysqli-affected-rows"> <refnamediv> <refname>mysqli_affected_rows</refname> <refname>mysqli->affected_rows</refname> <refpurpose>Gets the number of affected rows in a previous MySQL operation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>int</type><methodname>mysqli_affected_rows</methodname> @@ -19,39 +20,45 @@ <fieldsynopsis><type>int</type><varname>affected_rows</varname></fieldsynopsis> </classsynopsis> <para> - <function>mysqli_affected_rows</function> returns the number of rows affected by the last - INSERT, UPDATE, REPLACE or DELETE query associated with the provided <parameter>link</parameter> - parameter. If the last query was invalid, this function will return -1. + Returns the number of rows affected by the last <literal>INSERT</literal>, + <literal>UPDATE</literal>, <literal>REPLACE</literal> or + <literal>DELETE</literal> query. </para> <para> - The <function>mysqli_affected_rows</function> function only works with queries which modify - a table. In order to return the number of rows from a SELECT query, use the + This function only works with queries which modify a table. In order to + return the number of rows from a <literal>SELECT</literal> query, use the <function>mysqli_num_rows</function> function instead. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.link.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - An integer greater than zero indicates the number of rows affected or retrieved. - Zero indicates that no records where updated for an UPDATE statement, no rows matched - the WHERE clause in the query or that no query has yet been executed. - -1 indicates that the query returned an error. + An integer greater than zero indicates the number of rows affected or + retrieved. + Zero indicates that no records where updated for an UPDATE statement, no + rows matched the <literal>WHERE</literal> clause in the query or that no + query has yet been executed. -1 indicates that the query returned an + error. </para> <note> <para> - If the number of affected rows is greater than maximal int value, the number of affected rows - will be returned as a string. + If the number of affected rows is greater than maximal int value, the + number of affected rows will be returned as a string. </para> </note> </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_num_rows</function>&listendand; - <function>mysqli_info</function>. - </para> - </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -146,6 +153,17 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_num_rows</function></member> + <member><function>mysqli_info</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-autocommit"> <refnamediv> <refname>mysqli_autocommit</refname> - <refname>mysqli->autocommit</refname> + <refname>mysqli->autocommit()</refname> <refpurpose>Turns on or off auto-commiting database modifications</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_autocommit</methodname> @@ -23,35 +24,49 @@ </methodsynopsis> </classsynopsis> <para> - <function>mysqli_autocommit</function> is used to turn on or off auto-commit mode - on queries for the database connection represented by the <parameter>link</parameter> - object. + Turns on or off auto-commit mode on queries for the database connection. + </para> + <para> + To determine the current state of autocommit use the SQL command + <literal>SELECT @@autocommit</literal>. </para> - <note> - <para> - <function>mysqli_autocommit</function> doesn't work with non transactional - table types (like MyISAM or ISAM). - </para> - <para> - To determine the current state of autocommit use the SQL command - 'SELECT @@autocommit'. - </para> - </note> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success; + <variablelist> + &mysqli.link.description; + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + Whether to turn on auto-commit or not. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_commit</function>&listendand; - <function>mysqli_rollback</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function doesn't work with non transactional table types (like + MyISAM or ISAM). + </para> + </note> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -114,6 +129,17 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_commit</function></member> + <member><function>mysqli_rollback</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-bind-param"> <refnamediv> <refname>mysqli_bind_param</refname> <refpurpose>Alias for <function>mysqli_stmt_bind_param</function></refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para> This function is an alias of <function>mysqli_stmt_bind_param</function>. - For a detailled descripton see description of - <function>mysqli_stmt_bind_param</function>. </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> <function>mysqli_bind_param</function> is deprecated and will be removed. </para> </note> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_stmt_bind_param</function>. + <simplelist> + <member><function>mysqli_stmt_bind_param</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-bind-result"> <refnamediv> <refname>mysqli_bind_result</refname> <refpurpose>Alias for <function>mysqli_stmt_bind_result</function></refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para> This function is an alias of <function>mysqli_stmt_bind_result</function>. - For a detailled descripton see description of - <function>mysqli_stmt_bind_result</function>. </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> <function>mysqli_bind_result</function> is deprecated and will be removed. </para> </note> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_stmt_bind_result</function>. + <simplelist> + <member><function>mysqli_stmt_bind_result</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-change-user"> <refnamediv> <refname>mysqli_change_user</refname> - <refname>mysqli->change_user</refname> + <refname>mysqli->change_user()</refname> <refpurpose>Changes the user of the specified database connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_change_user</methodname> @@ -27,14 +28,8 @@ </methodsynopsis> </classsynopsis> <para> - <function>mysqli_change_user</function> is used to change the user of the specified - database connection as given by the <parameter>link</parameter> parameter and to set the - current database to that specified by the <parameter>database</parameter> parameter. - </para> - <para> - If desired, the &null; value may be passed in place of the <parameter>database</parameter> - parameter resulting in only changing the user and not selecting a database. To select - a database in this case use the <function>mysqli_select_db</function> function. + Changes the user of the specified database connection and sets the current + database. </para> <para> In order to successfully change users a valid <parameter>username</parameter> and @@ -42,29 +37,67 @@ sufficient permissions to access the desired database. If for any reason authorization fails, the current user authentication will remain. </para> - <note> - <para> - Using this command will always cause the current database connection to behave as if - was a completely new database connection, regardless of if the operation was completed - successfully. This reset includes performing a rollback on any active transactions, - closing all temporary tables, and unlocking all locked tables. - </para> - </note> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success; + <variablelist> + &mysqli.link.description; + <varlistentry> + <term><parameter>user</parameter></term> + <listitem> + <para> + The MySQL user name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The MySQL password. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>database</parameter></term> + <listitem> + <para> + The database to change to. + </para> + <para> + If desired, the &null; value may be passed resulting in only changing + the user and not selecting a database. To select a database in this + case use the <function>mysqli_select_db</function> function. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_connect</function>&listendand; - <function>mysqli_select_db</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + Using this command will always cause the current database connection to + behave as if was a completely new database connection, regardless of if + the operation was completed successfully. This reset includes performing + a rollback on any active transactions, closing all temporary tables, and + unlocking all locked tables. + </para> + </note> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -155,6 +188,17 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_connect</function></member> + <member><function>mysqli_select_db</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-character-set-name"> <refnamediv> <refname>mysqli_character_set_name</refname> - <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> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>string</type><methodname>mysqli_character_set_name</methodname> @@ -22,22 +23,25 @@ </methodsynopsis> </classsynopsis> <para> - Returns the current character set for the database connection specified by the - <parameter>link</parameter> parameter. + Returns the current character set for the database connection. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; - <para>The default character set for the current connection</para> - </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>mysqli_client_encoding</function>&listendand; - <function>mysqli_real_escape_string</function>. + <variablelist> + &mysqli.link.description; + </variablelist> </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para>The default character set for the current connection</para> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -93,6 +97,17 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_client_encoding</function></member> + <member><function>mysqli_real_escape_string</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-client-encoding"> <refnamediv> <refname>mysqli_client_encoding</refname> <refpurpose>Alias of <function>mysqli_character_set_name</function></refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para> This function is an alias of <function>mysqli_character_set_name</function>. - For a detailled descripton see description of - <function>mysqli_character_set_name</function>. </para> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_real_escape_string</function>. + <simplelist> + <member><function>mysqli_real_escape_string</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-close"> <refnamediv> <refname>mysqli_close</refname> - <refname>mysqli->close</refname> + <refname>mysqli->close()</refname> <refpurpose>Closes a previously opened database connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_close</methodname> @@ -22,24 +23,37 @@ </methodsynopsis> </classsynopsis> <para> - The <function>mysqli_close</function> function closes a previously opened database - connection specified by the <parameter>link</parameter> parameter. + Closes a previously opened database connection. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.link.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_connect</function>, - <function>mysqli_init</function>&listendand; - <function>mysqli_real_connect</function>. + <simplelist> + <member><function>mysqli_connect</function></member> + <member><function>mysqli_init</function></member> + <member><function>mysqli_real_connect</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-commit"> <refnamediv> <refname>mysqli_commit</refname> - <refname>mysqli->commit</refname> + <refname>mysqli->commit()</refname> <refpurpose>Commits the current transaction</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_commit</methodname> @@ -22,24 +23,27 @@ </methodsynopsis> </classsynopsis> <para> - Commits the current transaction for the database connection specified by the - <parameter>link</parameter> parameter. + Commits the current transaction for the database connection. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success; + <variablelist> + &mysqli.link.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_autocommit</function>&listendand; - <function>mysqli_rollback</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <para> <example> @@ -109,6 +113,17 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_autocommit</function></member> + <member><function>mysqli_rollback</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-connect-errno"> <refnamediv> <refname>mysqli_connect_errno</refname> <refpurpose>Returns the error code from last connect call</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>mysqli_connect_errno</methodname> <void /> </methodsynopsis> <para> - The <function>mysqli_connect_errno</function> function will return the last error code number - for last call to <function>mysqli_connect</function>. - If no errors have occured, this function will return zero. + Returns the last error code number from the last call to + <function>mysqli_connect</function>. </para> <note> <para> - Client error message numbers are listed in the MySQL <filename>errmsg.h</filename> header file, - server error message numbers are listed in <filename>mysqld_error.h</filename>. - In the MySQL source distribution you can find a complete list of error messages and error numbers - in the file <filename>Docs/mysqld_error.txt</filename>. + Client error message numbers are listed in the MySQL + <filename>errmsg.h</filename> header file, server error message numbers + are listed in <filename>mysqld_error.h</filename>. In the MySQL source + distribution you can find a complete list of error messages and error + numbers in the file <filename>Docs/mysqld_error.txt</filename>. </para> </note> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> An error code value for the last call to <function>mysqli_connect</function>, if it failed. zero means no error occurred. </para> </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_connect</function>, - <function>mysqli_connect_error</function>, - <function>mysqli_errno</function>, - <function>mysqli_error</function>&listendand; - <function>mysqli_sqlstate</function>. - </para> - </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>mysqli_connect_errno sample</title> + <title><function>mysqli_connect_errno</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -62,6 +55,20 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_connect</function></member> + <member><function>mysqli_connect_error</function></member> + <member><function>mysqli_errno</function></member> + <member><function>mysqli_error</function></member> + <member><function>mysqli_sqlstate</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-connect-error"> <refnamediv> <refname>mysqli_connect_error</refname> <refpurpose>Returns a string description of the last connect error</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>mysqli_connect_error</methodname> <void /> </methodsynopsis> <para> - The <function>mysqli_connect_error</function> function is identical to the corresponding - <function>mysqli_connect_errno</function> function in every way, except instead of returning - an integer error code the <function>mysqli_connect_error</function> function will return - a string representation of the last error to occur for the last - <function>mysqli_connect</function> call. - If no error has occured, this function will return an empty string. + Returns the last error message string from the last call to + <function>mysqli_connect</function>. </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - A string that describes the error. An empty string if no error occurred. - </para> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_connect</function>, - <function>mysqli_connect_errno</function>, - <function>mysqli_errno</function>, - <function>mysqli_error</function>&listendand; - <function>mysqli_sqlstate</function>. + A string that describes the error. An empty string if no error occurred. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <para> <example> - <title>mysqli_connect_error sample</title> + <title><function>mysqli_connect_error</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -56,6 +45,20 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_connect</function></member> + <member><function>mysqli_connect_errno</function></member> + <member><function>mysqli_errno</function></member> + <member><function>mysqli_error</function></member> + <member><function>mysqli_sqlstate</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-connect"> <refnamediv> <refname>mysqli_connect</refname> - <refname>mysqli()</refname> + <refname>mysqli->__construct()</refname> <refpurpose>Open a new connection to the MySQL server</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style</para> <methodsynopsis> <type>mysqli</type><methodname>mysqli_connect</methodname> @@ -32,46 +33,91 @@ </constructorsynopsis> </classsynopsis> <para> - The <function>mysqli_connect</function> function attempts to open a connection to the MySQL Server - running on <parameter>host</parameter> which can be either a host name or an IP address. Passing the - &null; value or the string "localhost" to this parameter, the local host is assumed. When possible, - pipes will be used instead of the TCP/IP protocol. If successful, the <function>mysqli_connect</function> - will return an object representing the connection to the database, or &false; on failure. - </para> - <para> - The <parameter>username</parameter> and <parameter>password</parameter> parameters specify the - username and password under which to connect to the MySQL server. If the password is not provided - (the &null; value is passed), the MySQL server will attempt to authenticate the user against those - user records which have no password only. This allows one username to be used with different - permissions (depending on if a password as provided or not). - </para> - <para> - The <parameter>dbname</parameter> parameter if provided will specify the default database to be - used when performing queries. + Opens a connection to the MySQL Server running on. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The <parameter>port</parameter> and <parameter>socket</parameter> parameters are used in - conjunction with the <parameter>host</parameter> parameter to further control how to connect - to the database server. The <parameter>port</parameter> parameter specifies the port number to - attempt to connect to the MySQL server on, while the <parameter>socket</parameter> parameter - specifies the socket or named pipe that should be used. + <variablelist> + <varlistentry> + <term><parameter>host</parameter></term> + <listitem> + <para> + Can be either a host name or an IP address. Passing the &null; value + or the string "localhost" to this parameter, the local host is + assumed. When possible, pipes will be used instead of the TCP/IP + protocol. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The MySQL user name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>passwd</parameter></term> + <listitem> + <para> + If provided or &null;, the MySQL server will attempt to authenticate + the user against those user records which have no password only. This + allows one username to be used with different permissions (depending + on if a password as provided or not). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dbname</parameter></term> + <listitem> + <para> + If provided will specify the default database to be used when + performing queries. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>port</parameter></term> + <listitem> + <para> + Specifies the port number to attempt to connect to the MySQL server. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>socket</parameter></term> + <listitem> + <para> + Specifies the socket or named pipe that should be used. + </para> + <note> + <para> + Specifying the <parameter>socket</parameter> parameter will not + explicitly determine the type of connection to be used when + connecting to the MySQL server. How the connection is made to the + MySQL database is determined by the <parameter>host</parameter> + parameter. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> </para> - <note> - <para> - Specifying the <parameter>socket</parameter> parameter will not explicitly determine the type - of connection to be used when connecting to the MySQL server. How the connection is made to the - MySQL database is determined by the <parameter>host</parameter> parameter. - </para> - </note> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns a object which represents the connection to a MySQL Server or &false; if the connection failed. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -122,6 +168,7 @@ ]]> </screen> </refsect1> + </refentry>  + <refentry id="function.mysqli-data-seek"> <refnamediv> <refname>mysqli_data_seek</refname> - <refname>result->data_seek</refname> + <refname>result->data_seek()</refname> <refpurpose>Adjusts the result pointer to an arbitary row in the result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_data_seek</methodname> @@ -23,37 +24,49 @@ </methodsynopsis> </classsynopsis> <para> - The <function>mysqli_data_seek</function> function seeks to an arbitrary result pointer - specified by the <parameter>offset</parameter> in the result set represented by - <parameter>result</parameter>. The <parameter>offset</parameter> parameter must be between - zero and the total number of rows minus one (0..<function>mysqli_num_rows</function> - 1). + The <function>mysqli_data_seek</function> function seeks to an arbitrary + result pointer specified by the <parameter>offset</parameter> in the + result set. </para> - <note> - <para> - This function can only be used with buffered results attained from the use of the - <function>mysqli_store_result</function> or <function>mysqli_query</function> functions. - </para> - </note> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success; + <variablelist> + &mysqli.result.description; + <varlistentry> + <term><parameter>offset</parameter></term> + <listitem> + <para> + The field offset. Must be between zero and the total number of rows + minus one (0..<function>mysqli_num_rows</function> - 1). + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_store_result</function>, - <function>mysqli_fetch_row</function>, - <function>mysqli_fetch_array</function>, - <function>mysqli_fetch_assoc</function>, - <function>mysqli_fetch_object</function>, - <function>mysqli_query</function>&listendand; - <function>mysqli_num_rows</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function can only be used with buffered results attained from the + use of the <function>mysqli_store_result</function> or + <function>mysqli_query</function> functions. + </para> + </note> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -133,6 +146,22 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_store_result</function></member> + <member><function>mysqli_fetch_row</function></member> + <member><function>mysqli_fetch_array</function></member> + <member><function>mysqli_fetch_assoc</function></member> + <member><function>mysqli_fetch_object</function></member> + <member><function>mysqli_query</function></member> + <member><function>mysqli_num_rows</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-debug"> <refnamediv> <refname>mysqli_debug</refname> <refpurpose>Performs debugging operations</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mysqli_debug</methodname> <methodparam><type>string</type><parameter>debug</parameter></methodparam> </methodsynopsis> <para> - The <function>mysqli_debug</function> function is used to perform debugging - operations using the Fred Fish debugging library. The <parameter>debug</parameter> - parameter is a string representing the debugging operation to perform. + Performs debugging operations using the Fred Fish debugging library. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>debug</parameter></term> + <listitem> + <para> + A string representing the debugging operation to perform + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true;. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> To use the <function>mysqli_debug</function> function you must complile @@ -23,18 +49,8 @@ </para> </note> </refsect1> - <refsect1> - &reftitle.returnvalues; - <para><function>mysqli_debug</function> doesn't return any value.</para> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_dump_debug_info</function>&listendand; - <function>mysqli_report</function>. - </para> - </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <para> <example> @@ -52,6 +68,17 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_dump_debug_info</function></member> + <member><function>mysqli_report</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-disable-reads-from-master"> <refnamediv> <refname>mysqli_disable_reads_from_master</refname> - <refname>mysqli->disable_reads_from_master</refname> + <refname>mysqli->disable_reads_from_master()</refname> <refpurpose>Disable reads from master</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_disable_reads_from_master</methodname> @@ -25,6 +26,7 @@ &warn.undocumented.func; </refsect1> + </refentry>  + <refentry id="function.mysqli-disable-rpl-parse"> <refnamediv> <refname>mysqli_disable_rpl_parse</refname> <refpurpose>Disable RPL parse</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mysqli_disable_rpl_parse</methodname> <methodparam><type>mysqli</type><parameter>link</parameter></methodparam> @@ -15,6 +16,7 @@ &warn.undocumented.func; </refsect1> + </refentry>  + <refentry id="function.mysqli-dump-debug-info"> <refnamediv> <refname>mysqli_dump_debug_info</refname> - <refname>mysqli->dump_debug_info</refname> + <refname>mysqli->dump_debug_info()</refname> <refpurpose>Dump debugging information into the log</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mysqli_dump_debug_info</methodname> <methodparam><type>mysqli</type><parameter>link</parameter></methodparam> </methodsynopsis> <para> - This function is designed to be executed by an user with the SUPER privilege and - is used to dump debugging information into the log for the MySQL Server relating - to the connection specified by the <parameter>link</parameter> parameter. + This function is designed to be executed by an user with the SUPER + privilege and is used to dump debugging information into the log for the + MySQL Server relating to the connection. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.link.description; + </variablelist> </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_debug</function>. + <simplelist> + <member><function>mysqli_debug</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-embedded-connect"> <refnamediv> <refname>mysqli_embedded_connect</refname> <refpurpose>Open a connection to an embedded mysql server</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mysqli</type><methodname>mysqli_embedded_connect</methodname> <methodparam choice="opt"><type>string</type><parameter>dbname</parameter></methodparam> @@ -15,6 +16,7 @@ &warn.undocumented.func; </refsect1> + </refentry>  + <refentry id="function.mysqli-enable-reads-from-master"> <refnamediv> <refname>mysqli_enable_reads_from_master</refname> <refpurpose>Enable reads from master</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mysqli_enable_reads_from_master</methodname> <methodparam><type>mysqli</type><parameter>link</parameter></methodparam> @@ -15,6 +16,7 @@ &warn.undocumented.func; </refsect1> + </refentry>  + <refentry id="function.mysqli-enable-rpl-parse"> <refnamediv> <refname>mysqli_enable_rpl_parse</refname> <refpurpose>Enable RPL parse</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mysqli_enable_rpl_parse</methodname> <methodparam><type>mysqli</type><parameter>link</parameter></methodparam> @@ -15,6 +16,7 @@ &warn.undocumented.func; </refsect1> + </refentry>  + <refentry id="function.mysqli-errno"> <refnamediv> <refname>mysqli_errno</refname> <refname>mysqli->errno</refname> <refpurpose>Returns the error code for the most recent function call</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>int</type><methodname>mysqli_errno</methodname> @@ -19,36 +20,37 @@ <fieldsynopsis><type>int</type><varname>errno</varname></fieldsynopsis> </classsynopsis> <para> - The <function>mysqli_errno</function> function will return the last error code for - the most recent MySQLi function call that can succeed or fail with respect to the - database link defined by the <parameter>link</parameter> parameter. If no errors - have occured, this function will return zero. + Returns the last error code for the most recent MySQLi function call that + can succeed or fail. + </para> + <para> + Client error message numbers are listed in the MySQL + <filename>errmsg.h</filename> header file, server error message numbers + are listed in <filename>mysqld_error.h</filename>. + In the MySQL source distribution you can find a complete list of error + messages and error numbers in the file + <filename>Docs/mysqld_error.txt</filename>. </para> - <note> - <para> - Client error message numbers are listed in the MySQL <filename>errmsg.h</filename> header file, - server error message numbers are listed in <filename>mysqld_error.h</filename>. - In the MySQL source distribution you can find a complete list of error messages and error numbers - in the file <filename>Docs/mysqld_error.txt</filename>. - </para> - </note> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - An error code value for the last call, if it failed. zero means no error occurred. + <variablelist> + &mysqli.link.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_connect_errno</function>, - <function>mysqli_connect_error</function>, - <function>mysqli_error</function>&listendand; - <function>mysqli_sqlstate</function>. + An error code value for the last call, if it failed. zero means no error + occurred. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -103,6 +105,19 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_connect_errno</function></member> + <member><function>mysqli_connect_error</function></member> + <member><function>mysqli_error</function></member> + <member><function>mysqli_sqlstate</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-error"> <refnamediv> <refname>mysqli_error</refname> <refpurpose>Returns a string description of the last error</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>string</type><methodname>mysqli_error</methodname> @@ -18,30 +19,28 @@ <fieldsynopsis><type>string</type><varname>error</varname></fieldsynopsis> </classsynopsis> <para> - The <function>mysqli_error</function> function is identical to the corresponding - <function>mysqli_errno</function> function in every way, except instead of returning - an integer error code the <function>mysqli_error</function> function will return - a string representation of the last error to occur for the database connection - represented by the <parameter>link</parameter> parameter. If no error has occured, - this function will return an empty string. + Returns the last error message for the most recent MySQLi function call + that can succeed or fail. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - A string that describes the error. An empty string if no error occurred. + <variablelist> + &mysqli.link.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_connect_errno</function>, - <function>mysqli_connect_error</function>, - <function>mysqli_errno</function>&listendand; - <function>mysqli_sqlstate</function>. + A string that describes the error. An empty string if no error occurred. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -96,6 +95,19 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_connect_errno</function></member> + <member><function>mysqli_connect_error</function></member> + <member><function>mysqli_errno</function></member> + <member><function>mysqli_sqlstate</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-escape-string"> <refnamediv> <refname>mysqli_escape_string</refname> <refpurpose>Alias of <function>mysqli_real_escape_string</function></refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para> This function is an alias of <function>mysqli_real_escape_string</function>. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_real_escape_string</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-execute"> <refnamediv> <refname>mysqli_execute</refname> <refpurpose>Alias for <function>mysqli_stmt_execute</function></refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para> This function is an alias of <function>mysqli_stmt_execute</function>. - For a detailled descripton see description of - <function>mysqli_stmt_execute</function>. </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> <function>mysqli_execute</function> is deprecated and will be removed. </para> </note> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_stmt_execute</function>. + <simplelist> + <member><function>mysqli_stmt_execute</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-fetch-array"> <refnamediv> <refname>mysqli_fetch_array</refname> - <refname>result->fetch_array</refname> + <refname>result->fetch_array()</refname> <refpurpose>Fetch a result row as an associative, a numeric array, or both</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>mixed</type><methodname>mysqli_fetch_array</methodname> @@ -23,52 +24,65 @@ </methodsynopsis> </classsynopsis> <para> - Returns an array that corresponds to the fetched row or &null; if there are no more rows for the - resultset represented by the <parameter>result</parameter> parameter. + Returns an array that corresponds to the fetched row or &null; if there + are no more rows for the resultset represented by the + <parameter>result</parameter> parameter. </para> <para> <function>mysqli_fetch_array</function> is an extended version of the - <function>mysqli_fetch_row</function> function. In addition to storing the data in the - numeric indices of the result array, the <function>mysqli_fetch_array</function> function can - also store the data in associative indices, using the field names of the result set as keys. + <function>mysqli_fetch_row</function> function. In addition to storing the + data in the numeric indices of the result array, the + <function>mysqli_fetch_array</function> function can also store the data + in associative indices, using the field names of the result set as keys. </para> &database.field-case; &database.fetch-null; <para> - If two or more columns of the result have the same field names, the last column will take - precedence and overwrite the earlier data. In order to access multiple columns with the same - name, the numerically indexed version of the row must be used. - </para> - <para> - The optional second argument <parameter>resulttype</parameter> is a constant indicating what - type of array should be produced from the current row data. The possible values for this parameter - are the constants MYSQLI_ASSOC, MYSQLI_NUM, or MYSQLI_BOTH. By default the - <function>mysqli_fetch_array</function> function will assume MYSQLI_BOTH for this parameter. - </para> - <para> - By using the MYSQLI_ASSOC constant this function will behave identically to the - <function>mysqli_fetch_assoc</function>, while MYSQLI_NUM will behave identically to the - <function>mysqli_fetch_row</function> function. The final option MYSQLI_BOTH will create a single - array with the attributes of both. + If two or more columns of the result have the same field names, the last + column will take precedence and overwrite the earlier data. In order to + access multiple columns with the same name, the numerically indexed + version of the row must be used. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Returns an array that corresponds to the fetched row or &null; if there are no more rows in resultset. + <variablelist> + &mysqli.result.description; + <varlistentry> + <term><parameter>resulttype</parameter></term> + <listitem> + <para> + This optional parameter is a constant indicating what type of array + should be produced from the current row data. The possible values for + this parameter are the constants <constant>MYSQLI_ASSOC</constant>, + <constant>MYSQLI_NUM</constant>, or <constant>MYSQLI_BOTH</constant>. + Defaults to <constant>MYSQLI_BOTH</constant>. + </para> + <para> + By using the <constant>MYSQLI_ASSOC</constant> constant this function + will behave identically to the <function>mysqli_fetch_assoc</function>, + while <constant>MYSQLI_NUM</constant> will behave identically to the + <function>mysqli_fetch_row</function> function. The final option + <constant>MYSQLI_BOTH</constant> will create a single array with the + attributes of both. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_fetch_assoc</function>, - <function>mysqli_fetch_row</function>, - <function>mysqli_fetch_object</function>, - <function>mysqli_query</function>&listendand; - <function>mysqli_data_seek</function>. + Returns an array that corresponds to the fetched row or &null; if there + are no more rows in resultset. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -153,6 +167,20 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_fetch_assoc</function></member> + <member><function>mysqli_fetch_row</function></member> + <member><function>mysqli_fetch_object</function></member> + <member><function>mysqli_query</function></member> + <member><function>mysqli_data_seek</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-fetch-assoc"> <refnamediv> <refname>mysqli_fetch_assoc</refname> - <refname>mysqli->fetch_assoc</refname> + <refname>mysqli->fetch_assoc()</refname> <refpurpose>Fetch a result row as an associative array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>array</type><methodname>mysqli_fetch_assoc</methodname> @@ -22,42 +23,38 @@ </methodsynopsis> </classsynopsis> <para> - Returns an associative array that corresponds to the fetched row or &null; if there are - no more rows. - </para> - <para> - The <function>mysqli_fetch_assoc</function> function is used to return an associative array - representing the next row in the result set for the result represented by the - <parameter>result</parameter> parameter, where each key in the array represents the name - of one of the result set's columns. - </para> - <para> - If two or more columns of the result have the same field names, - the last column will take precedence. To access the other - column(s) of the same name, you either need to access the - result with numeric indices by using - <function>mysqli_fetch_row</function> or add alias names. + Returns an associative array that corresponds to the fetched row or &null; + if there are no more rows. </para> &database.field-case; &database.fetch-null; </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Returns an array that corresponds to the fetched row or &null; if there are no more rows in resultset. + <variablelist> + &mysqli.result.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_fetch_array</function>, - <function>mysqli_fetch_row</function>, - <function>mysqli_fetch_object</function>, - <function>mysqli_query</function>&listendand; - <function>mysqli_data_seek</function>. + Returns an associative array representing the fetched row in the result + set, where each key in the array represents the name of one of the result + set's columns or &null; if there are no more rows in resultset. + </para> + <para> + If two or more columns of the result have the same field names, the last + column will take precedence. To access the other column(s) of the same + name, you either need to access the result with numeric indices by using + <function>mysqli_fetch_row</function> or add alias names. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -134,6 +131,20 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_fetch_array</function></member> + <member><function>mysqli_fetch_row</function></member> + <member><function>mysqli_fetch_object</function></member> + <member><function>mysqli_query</function></member> + <member><function>mysqli_data_seek</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-fetch-field-direct"> <refnamediv> <refname>mysqli_fetch_field_direct</refname> - <refname>result->fetch_field_direct</refname> + <refname>result->fetch_field_direct()</refname> <refpurpose>Fetch meta-data for a single field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>object</type><methodname>mysqli_fetch_field_direct</methodname> @@ -23,16 +24,35 @@ </methodsynopsis> </classsynopsis> <para> - <function>mysqli_fetch_field_direct</function> returns an object which contains - field definition informations from specified resultset. The value of fieldnr must be in the - range from <literal>0</literal> to <literal>number of fields - 1</literal>. + Returns an object which contains field definition informations from + specified resultset. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.result.description; + <varlistentry> + <term><parameter>fieldnr</parameter></term> + <listitem> + <para> + The field number. This value must be in the range from + <literal>0</literal> to <literal>number of fields - 1</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns an object which contains field definition information or &false; if no field information - for specified <literal>fieldnr</literal> is available. + Returns an object which contains field definition information or &false; + if no field information for specified <literal>fieldnr</literal> is + available. </para> <para> <table> @@ -94,15 +114,8 @@ </table> </para> </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_num_fields</function>, - <function>mysqli_fetch_field</function>&listendand; - <function>mysqli_fetch_fields</function>. - </para> - </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -185,6 +198,18 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_num_fields</function></member> + <member><function>mysqli_fetch_field</function></member> + <member><function>mysqli_fetch_fields</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-fetch-field"> <refnamediv> <refname>mysqli_fetch_field</refname> - <refname>result->fetch_field</refname> + <refname>result->fetch_field()</refname> <refpurpose>Returns the next field in the result set</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>object</type><methodname>mysqli_fetch_field</methodname> @@ -22,18 +23,26 @@ </methodsynopsis> </classsynopsis> <para> - The <function>mysqli_fetch_field</function> returns the definition of one column - of a result set as an object. Call this function repeatedly to retrieve - information about all columns in the result set. - <function>mysqli_fetch_field</function> returns &false; when no more fields - are left. + Returns the definition of one column of a result set as an object. Call + this function repeatedly to retrieve information about all columns in the + result set. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.result.description; + </variablelist> </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns an object which contains field definition information or &false; if no field information - is available. + Returns an object which contains field definition information or &false; + if no field information is available. </para> <para> <table> @@ -95,16 +104,8 @@ </table> </para> </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_num_fields</function>, - <function>mysqli_fetch_field_direct</function>, - <function>mysqli_fetch_fields</function>&listendand; - <function>mysqli_field_seek</function>. - </para> - </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -194,6 +195,19 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_num_fields</function></member> + <member><function>mysqli_fetch_field_direct</function></member> + <member><function>mysqli_fetch_fields</function></member> + <member><function>mysqli_field_seek</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-fetch-fields"> <refnamediv> <refname>mysqli_fetch_fields</refname> - <refname>result->fetch_fields</refname> + <refname>result->fetch_fields()</refname> <refpurpose>Returns an array of objects representing the fields in a result set</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural Style:</para> <methodsynopsis> <type>array</type><methodname>mysqli_fetch_fields</methodname> @@ -22,16 +23,27 @@ </methodsynopsis> </classsynopsis> <para> - This function serves an identical purpose to the <function>mysqli_fetch_field</function> - function with the single difference that, instead of returning one object at a time for - each field, the columns are returned as an array of objects. + This function serves an identical purpose to the + <function>mysqli_fetch_field</function> function with the single + difference that, instead of returning one object at a time for each field, + the columns are returned as an array of objects. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.result.description; + </variablelist> </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns an array of objects which contains field definition information or &false; if no field information - is available. + Returns an array of objects which contains field definition information or + &false; if no field information is available. </para> <para> <table> @@ -93,15 +105,8 @@ </table> </para> </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_num_fields</function>, - <function>mysqli_fetch_field</function>&listendand; - <function>mysqli_fetch_field_direct</function>. - </para> - </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -193,6 +198,18 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_num_fields</function></member> + <member><function>mysqli_fetch_field_direct</function></member> + <member><function>mysqli_fetch_field</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-fetch-lengths"> <refnamediv> <refname>mysqli_fetch_lengths</refname> - <refname>result->lengths</refname> + <refname>result->lengths()</refname> <refpurpose>Returns the lengths of the columns of the current row in the result set</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>array</type><methodname>mysqli_fetch_lengths</methodname> @@ -19,25 +20,35 @@ <fieldsynopsis><type>array</type><varname>lengths</varname></fieldsynopsis> </classsynopsis> <para> - The <function>mysqli_fetch_lengths</function> function returns an array containing the - lengths of every column of the current row within the result set represented by the - <parameter>result</parameter> parameter. If successful, a numerically indexed array - representing the lengths of each column is returned or &false; on failure. + The <function>mysqli_fetch_lengths</function> function returns an array + containing the lengths of every column of the current row within the result + set. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.result.description; + </variablelist> </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> An array of integers representing the size of each column (not including any terminating null characters). &false; if an error occurred. </para> <para> - <function>mysqli_fetch_lengths</function> is valid only for the current row of the result set. - It returns &false; if you call it before calling mysqli_fetch_row/array/object or after retrieving - all rows in the result. + <function>mysqli_fetch_lengths</function> is valid only for the current + row of the result set. It returns &false; if you call it before calling + mysqli_fetch_row/array/object or after retrieving all rows in the result. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -124,6 +135,7 @@ ]]> </screen> </refsect1> + </refentry>  + <refentry id="function.mysqli-fetch-object"> <refnamediv> <refname>mysqli_fetch_object</refname> - <refname>result->fetch_object</refname> + <refname>result->fetch_object()</refname> <refpurpose>Returns the current row of a result set as an object</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>object</type><methodname>mysqli_fetch_object</methodname> @@ -25,12 +26,36 @@ </methodsynopsis> </classsynopsis> <para> - The <function>mysqli_fetch_object</function> will return the current row result set - as an object where the attributes of the object represent the names of the fields found - within the result set. If no more rows exist in the current result set, &null; is returned. + The <function>mysqli_fetch_object</function> will return the current row + result set as an object where the attributes of the object represent the + names of the fields found within the result set. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.result.description; + <varlistentry> + <term><parameter>class_name</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>params</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns an object that corresponds to the fetched row or &null; if there are no more rows in resultset. @@ -38,6 +63,7 @@ &database.field-case; &database.fetch-null; </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <para> @@ -61,17 +87,8 @@ </informaltable> </para> </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_fetch_array</function>, - <function>mysqli_fetch_assoc</function>, - <function>mysqli_fetch_row</function>, - <function>mysqli_query</function>&listendand; - <function>mysqli_data_seek</function>. - </para> - </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -148,6 +165,20 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_fetch_array</function></member> + <member><function>mysqli_fetch_assoc</function></member> + <member><function>mysqli_fetch_row</function></member> + <member><function>mysqli_query</function></member> + <member><function>mysqli_data_seek</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-fetch-row"> <refnamediv> <refname>mysqli_fetch_row</refname> - <refname>result->fetch_row</refname> + <refname>result->fetch_row()</refname> <refpurpose>Get a result row as an enumerated array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>mixed</type><methodname>mysqli_fetch_row</methodname> @@ -22,17 +23,23 @@ </methodsynopsis> </classsynopsis> <para> - Returns an array that corresponds to the fetched row, or &null; if there are no more rows. + Fetches one row of data from the result set and returns it as an enumerated + array, where each column is stored in an array offset starting from 0 (zero). + Each subsequent call to this function will return the next row within the + result set, or &null; if there are no more rows. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>mysqli_fetch_row</function> fetches one row of data from the result set represented by - <parameter>result</parameter> and returns it as an enumerated array, where each column is stored - in an array offset starting from 0 (zero). Each subsequent call to the - <function>mysqli_fetch_row</function> function will return the next row within the result set, - or &null; if there are no more rows. + <variablelist> + &mysqli.result.description; + </variablelist> </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> <function>mysqli_fetch_row</function> returns an array that corresponds to the fetched row @@ -40,17 +47,8 @@ </para> &database.fetch-null; </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_fetch_array</function>, - <function>mysqli_fetch_assoc</function>, - <function>mysqli_fetch_object</function>, - <function>mysqli_query</function>&listendand; - <function>mysqli_data_seek</function>. - </para> - </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -127,6 +125,20 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_fetch_array</function></member> + <member><function>mysqli_fetch_assoc</function></member> + <member><function>mysqli_fetch_object</function></member> + <member><function>mysqli_query</function></member> + <member><function>mysqli_data_seek</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-fetch"> <refnamediv> <refname>mysqli_fetch</refname> <refpurpose>Alias for <function>mysqli_stmt_fetch</function></refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para> This function is an alias of <function>mysqli_stmt_fetch</function>. - For a detailled descripton see description of - <function>mysqli_stmt_fetch</function>. </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> <function>mysqli_fetch</function> is deprecated and will be removed. </para> </note> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_stmt_fetch</function>. + <simplelist> + <member><function>mysqli_stmt_fetch</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-field-count"> <refnamediv> <refname>mysqli_field_count</refname> - <refname>mysqli->field_count</refname> + <refname>mysqli->field_count()</refname> <refpurpose>Returns the number of columns for the most recent query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>int</type><methodname>mysqli_field_count</methodname> @@ -29,11 +30,24 @@ set or not without knowing the nature of the query. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.link.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para>An integer representing the number of fields in a result set</para> + <para> + An integer representing the number of fields in a result set. + </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <para> <example> @@ -101,6 +115,7 @@ </example> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-field-seek"> <refnamediv> <refname>mysqli_field_seek</refname> - <refname>result->field_seek</refname> + <refname>result->field_seek()</refname> <refpurpose>Set result pointer to a specified field offset</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_field_seek</methodname> @@ -23,26 +24,43 @@ </methodsynopsis> </classsynopsis> <para> - Sets the field cursor to the given offset. The next call to <function>mysqli_fetch_field</function> - will retrieve the field definition of the column associated with that offset. + Sets the field cursor to the given offset. The next call to + <function>mysqli_fetch_field</function> will retrieve the field definition + of the column associated with that offset. </para> <note> - <para>To seek to the beginning of a row, pass an offset value of zero.</para> + <para> + To seek to the beginning of a row, pass an offset value of zero. + </para> </note> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>mysqli_field_seek</function> returns previuos value of field cursor. + <variablelist> + &mysqli.result.description; + <varlistentry> + <term><parameter>fieldnr</parameter></term> + <listitem> + <para> + The field number. This value must be in the range from + <literal>0</literal> to <literal>number of fields - 1</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_fetch_field</function>. + Returns the previous value of field cursor. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -128,6 +146,16 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_fetch_field</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-field-tell"> <refnamediv> <refname>mysqli_field_tell</refname> <refname>result->current_field</refname> <refpurpose>Get current field offset of a result pointer</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>int</type><methodname>mysqli_field_tell</methodname> @@ -26,20 +27,24 @@ be used as an argument to <function>mysqli_field_seek</function>. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Returns current offset of field cursor. + <variablelist> + &mysqli.result.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_fetch_field</function>&listendand; - <function>mysqli_field_seek</function>. + Returns current offset of field cursor. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -139,6 +144,17 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_fetch_field</function></member> + <member><function>mysqli_field_seek</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-free-result"> <refnamediv> <refname>mysqli_free_result</refname> - <refname>result->free</refname> + <refname>result->free()</refname> <refpurpose>Frees the memory associated with a result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>void</type><methodname>mysqli_free_result</methodname> @@ -30,32 +31,42 @@ </methodsynopsis> </classsynopsis> <para> - The <function>mysqli_free_result</function> function frees the memory - associated with the result represented by the - <parameter>result</parameter> parameter, which was allocated by - <function>mysqli_query</function>, <function>mysqli_store_result</function> - or <function>mysqli_use_result</function>. + Frees the memory associated with the result. </para> <note> <para> - You should always free your result with <function>mysqli_free_result</function>, - when your result object is not needed anymore. + You should always free your result with + <function>mysqli_free_result</function>, when your result object is not + needed anymore. </para> </note> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.result.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - This function doesn't return any value. + &return.void; </para> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_query</function>, - <function>mysqli_stmt_store_result</function>, - <function>mysqli_store_result</function>&listendand; - <function>mysqli_use_result</function>. + <simplelist> + <member><function>mysqli_query</function></member> + <member><function>mysqli_stmt_store_result</function></member> + <member><function>mysqli_store_result</function></member> + <member><function>mysqli_use_result</function></member> + </simplelist> </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mysqli/functions/mysqli-get-client-info.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/mysqli/functions/mysqli-get-client-info.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-get-client-info.xml:1.8 phpdoc/en/reference/mysqli/functions/mysqli-get-client-info.xml:1.9 --- phpdoc/en/reference/mysqli/functions/mysqli-get-client-info.xml:1.8 Sat Jan 27 17:37:36 2007 +++ phpdoc/en/reference/mysqli/functions/mysqli-get-client-info.xml Sun Jan 28 04:25:57 2007 @@ -1,12 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.mysqli-get-client-info"> <refnamediv> <refname>mysqli_get_client_info</refname> <refpurpose>Returns the MySQL client version as a string</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>mysqli_get_client_info</methodname> <void /> @@ -17,21 +18,15 @@ MySQLi extension. </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> A string that represents the MySQL client library version </para> </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_get_client_version</function>, - <function>mysqli_get_server_info</function>&listendand; - <function>mysqli_get_server_version</function>. - </para> - </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <para> <example> @@ -50,6 +45,18 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_get_client_version</function></member> + <member><function>mysqli_get_server_info</function></member> + <member><function>mysqli_get_server_version</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-get-client-version"> <refnamediv> <refname>mysqli_get_client_version</refname> <refpurpose>Get MySQL client info</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>mysqli_get_client_version</methodname> <void/> @@ -15,7 +16,8 @@ Returns client version number as an integer. </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> A number that represents the MySQL client library version in format: @@ -27,15 +29,8 @@ to know if some capability exits. </para> </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_get_client_info</function>, - <function>mysqli_get_server_info</function>&listendand; - <function>mysqli_get_server_version</function>. - </para> - </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <para> <example> @@ -54,6 +49,18 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_get_client_info</function></member> + <member><function>mysqli_get_server_info</function></member> + <member><function>mysqli_get_server_version</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-get-host-info"> <refnamediv> <refname>mysqli_get_host_info</refname> - <refname>mysqli->get_host_info</refname> + <refname>mysqli->host_info</refname> <refpurpose>Returns a string representing the type of connection used</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procdural style:</para> <methodsynopsis> <type>string</type><methodname>mysqli_get_host_info</methodname> @@ -24,19 +25,24 @@ parameter is using (including the server host name). </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - A character string representing the server hostname and the connection type. + <variablelist> + &mysqli.link.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_get_proto_info</function>. + A character string representing the server hostname and the connection type. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -89,6 +95,16 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_get_proto_info</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-get-metadata"> <refnamediv> <refname>mysqli_get_metadata</refname> <refpurpose>Alias for <function>mysqli_stmt_result_metadata</function></refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para> This function is an alias of <function>mysqli_stmt_result_metadata</function>. - For a detailled descripton see description of - <function>mysqli_stmt_result_metadata</function>. </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> <function>mysqli_get_metadata</function> is deprecated and will be removed. </para> </note> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_stmt_result_metadata</function>. + <simplelist> + <member><function>mysqli_stmt_result_metadata</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-get-proto-info"> <refnamediv> <refname>mysqli_get_proto_info</refname> <refname>mysqli->protocol_version</refname> <refpurpose>Returns the version of the MySQL protocol used</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>int</type><methodname>mysqli_get_proto_info</methodname> @@ -23,19 +24,24 @@ connection represented by the <parameter>link</parameter> parameter. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Returns an integer representing the protocol version. + <variablelist> + &mysqli.link.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_get_host_info</function>. + Returns an integer representing the protocol version. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -88,6 +94,16 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_get_host_info</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-get-server-info"> <refnamediv> <refname>mysqli_get_server_info</refname> <refname>mysqli->server_info</refname> <refpurpose>Returns the version of the MySQL server</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>string</type><methodname>mysqli_get_server_info</methodname> @@ -20,25 +21,27 @@ </classsynopsis> <para> Returns a string representing the version of the MySQL server that the - MySQLi extension is connected to (represented by the - <parameter>link</parameter> parameter). + MySQLi extension is connected to. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - A character string representing the server version. + <variablelist> + &mysqli.link.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_get_client_info</function>, - <function>mysqli_get_client_version</function>&listendand; - <function>mysqli_get_server_version</function>. + A character string representing the server version. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -91,6 +94,18 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_get_client_info</function></member> + <member><function>mysqli_get_client_version</function></member> + <member><function>mysqli_get_server_version</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-get-server-version"> <refnamediv> <refname>mysqli_get_server_version</refname> + <refname>mysqli->server_version</refname> <refpurpose>Returns the version of the MySQL server as an integer</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>int</type><methodname>mysqli_get_server_version</methodname> @@ -22,27 +24,30 @@ version of the server connected to (represented by the <parameter>link</parameter> parameter) as an integer. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The form of this version number is - <literal>main_version * 10000 + minor_version * 100 + sub_version</literal> - (i.e. version 4.1.0 is 40100). + <variablelist> + &mysqli.link.description; + </variablelist> </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> An integer representing the server version. </para> - </refsect1> - <refsect1> - &reftitle.seealso; <para> - <function>mysqli_get_client_info</function>, - <function>mysqli_get_client_version</function>&listendand; - <function>mysqli_get_server_info</function>. + The form of this version number is + <literal>main_version * 10000 + minor_version * 100 + sub_version</literal> + (i.e. version 4.1.0 is 40100). </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -95,6 +100,18 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_get_client_info</function></member> + <member><function>mysqli_get_client_version</function></member> + <member><function>mysqli_get_server_info</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-info"> <refnamediv> <refname>mysqli_info</refname> <refname>mysqli->info</refname> <refpurpose>Retrieves information about the most recently executed query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>string</type><methodname>mysqli_info</methodname> @@ -65,21 +66,24 @@ </para> </note> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - A character string representing additional information about the most recently executed query. + <variablelist> + &mysqli.link.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_affected_rows</function>, - <function>mysqli_warning_count</function>&listendand; - <function>mysqli_num_rows</function>. + A character string representing additional information about the most recently executed query. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -138,6 +142,18 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_affected_rows</function></member> + <member><function>mysqli_warning_count</function></member> + <member><function>mysqli_num_rows</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-init"> <refnamediv> <refname>mysqli_init</refname> <refpurpose>Initializes MySQLi and returns a resource for use with mysqli_real_connect()</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mysqli</type><methodname>mysqli_init</methodname> <void/> </methodsynopsis> - <para> - Allocates or initializes a MYSQL object suitable for - <function>mysqli_options</function> and <function>mysqli_real_connect</function>. - </para> - <note> <para> - Any subsequent calls to any mysqli function (except <function>mysqli_options</function>) - will fail until <function>mysqli_real_connect</function> was called. + Allocates or initializes a MYSQL object suitable for + <function>mysqli_options</function> and <function>mysqli_real_connect</function>. </para> - </note> + <note> + <para> + Any subsequent calls to any mysqli function (except <function>mysqli_options</function>) + will fail until <function>mysqli_real_connect</function> was called. + </para> + </note> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns an object. </para> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_options</function>, - <function>mysqli_close</function>, - <function>mysqli_real_connect</function>&listendand; - <function>mysqli_connect</function>. + <simplelist> + <member><function>mysqli_options</function></member> + <member><function>mysqli_close</function></member> + <member><function>mysqli_real_connect</function></member> + <member><function>mysqli_connect</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-insert-id"> <refnamediv> <refname>mysqli_insert_id</refname> <refname>mysqli->insert_id</refname> <refpurpose>Returns the auto generated id used in the last query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>int</type><methodname>mysqli_insert_id</methodname> @@ -33,26 +34,37 @@ </para> </note> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.link.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - The value of the <literal>AUTO_INCREMENT</literal> field that was updated - by the previous query. Returns zero if there was no previous query on the - connection or if the query did not update an <literal>AUTO_INCREMENT</literal> - value. -</para> -<note> - <para> - If the number is greater than maximal int value, <function>mysqli_insert_id</function> - will return a string. - </para> -</note> + The value of the <literal>AUTO_INCREMENT</literal> field that was updated + by the previous query. Returns zero if there was no previous query on the + connection or if the query did not update an <literal>AUTO_INCREMENT</literal> + value. + </para> + <note> + <para> + If the number is greater than maximal int value, <function>mysqli_insert_id</function> + will return a string. + </para> + </note> </refsect1> - <refsect1> -&reftitle.examples; -<example> - <title>Object oriented style</title> - <programlisting role="php"> + + <refsect1 role="examples"> + &reftitle.examples; + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $mysqli = new mysqli("localhost", "my_user", "my_password", "world"); @@ -77,11 +89,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"); @@ -106,15 +118,16 @@ mysqli_close($link); ?> ]]> - </programlisting> -</example> -&example.outputs; -<screen> + </programlisting> + </example> + &example.outputs; + <screen> <![CDATA[ New Record has id 1. ]]> -</screen> + </screen> </refsect1> + </refentry>  + <refentry id="function.mysqli-kill"> <refnamediv> <refname>mysqli_kill</refname> - <refname>mysqli->kill</refname> + <refname>mysqli->kill()</refname> <refpurpose>Asks the server to kill a MySQL thread</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_kill</methodname> @@ -27,24 +28,29 @@ by the <parameter>processid</parameter> parameter. This value must be retrieved by calling the <function>mysqli_thread_id</function> function. </para> - <note> - <para> - To stop a running query you should use the SQL command - <literal>KILL QUERY processid</literal>. - </para> - </note> + <para> + To stop a running query you should use the SQL command + <literal>KILL QUERY processid</literal>. + </para> </refsect1> - <refsect1> - &reftitle.returnvalues; - <para>&return.success;</para> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.link.description; + </variablelist> + </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_thread_id</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -115,6 +121,16 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_thread_id</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-master-query"> <refnamediv> <refname>mysqli_master_query</refname> <refpurpose>Enforce execution of a query on the master in a master/slave setup</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mysqli_master_query</methodname> <methodparam><type>mysqli</type><parameter>link</parameter></methodparam> @@ -16,6 +17,7 @@ &warn.undocumented.func; </refsect1> + </refentry>  + <refentry id="function.mysqli-more-results"> <refnamediv> <refname>mysqli_more_results</refname> <refname>mysqli->more_results</refname> <refpurpose>Check if there are any more query results from a multi query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mysqli_more_results</methodname> <methodparam><type>mysqli</type><parameter>link</parameter></methodparam> </methodsynopsis> <para> - <function>mysqli_more_results</function> indicates if one or more result sets - are available from a previous call to <function>mysqli_multi_query</function>. + Indicates if one or more result sets are available from a previous call to + <function>mysqli_multi_query</function>. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; - <para>&return.success;</para> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.link.description; + </variablelist> + </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_multi_query</function>, - <function>mysqli_next_result</function>, - <function>mysqli_store_result</function>&listendand; - <function>mysqli_use_result</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <para>See <function>mysqli_multi_query</function>.</para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_multi_query</function></member> + <member><function>mysqli_next_result</function></member> + <member><function>mysqli_store_result</function></member> + <member><function>mysqli_use_result</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-multi-query"> <refnamediv> <refname>mysqli_multi_query</refname> - <refname>mysqli->multi_query</refname> + <refname>mysqli->multi_query()</refname> <refpurpose>Performs a query on the database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_multi_query</methodname> @@ -23,8 +24,7 @@ </methodsynopsis> </classsynopsis> <para> - The <function>mysqli_multi_query</function> executes one or multiple queries - which are concatenated by a semicolon. + Executes one or multiple queries which are concatenated by a semicolon. </para> <para> To retrieve the resultset from the first query you can use @@ -33,24 +33,34 @@ <function>mysqli_more_results</function> and <function>mysqli_next_result</function>. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>mysqli_multi_query</function> only returns &false; if the first statement failed. - To retrieve subsequent errors from other statements you have to call - <function>mysqli_next_result</function> first. + <variablelist> + &mysqli.link.description; + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + The query, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_use_result</function>, - <function>mysqli_store_result</function>, - <function>mysqli_next_result</function>&listendand; - <function>mysqli_more_results</function>. + Returns &false; if the first statement failed. + To retrieve subsequent errors from other statements you have to call + <function>mysqli_next_result</function> first. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -143,6 +153,19 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_use_result</function></member> + <member><function>mysqli_store_result</function></member> + <member><function>mysqli_next_result</function></member> + <member><function>mysqli_more_results</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-next-result"> <refnamediv> <refname>mysqli_next_result</refname> - <refname>mysqli->next_result</refname> + <refname>mysqli->next_result()</refname> <refpurpose>Prepare next result from multi_query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mysqli_next_result</methodname> <methodparam><type>mysqli</type><parameter>link</parameter></methodparam> </methodsynopsis> <para> - <function>mysqli_next_result</function> prepares next result set from a previous - call to <function>mysqli_multi_query</function> which can be retrieved by + Prepares next result set from a previous call to + <function>mysqli_multi_query</function> which can be retrieved by <function>mysqli_store_result</function> or <function>mysqli_use_result</function>. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; - <para>&return.success;</para> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.link.description; + </variablelist> + </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_multi_query</function>, - <function>mysqli_more_results</function>, - <function>mysqli_store_result</function>&listendand; - <function>mysqli_use_result</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <para> See <function>mysqli_multi_query</function>. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_multi_query</function></member> + <member><function>mysqli_more_results</function></member> + <member><function>mysqli_store_result</function></member> + <member><function>mysqli_use_result</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-num-fields"> <refnamediv> <refname>mysqli_num_fields</refname> <refname>result->field_count</refname> <refpurpose>Get the number of fields in a result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>int</type><methodname>mysqli_num_fields</methodname> @@ -19,20 +20,27 @@ <fieldsynopsis><type>int</type><varname>field_count</varname></fieldsynopsis> </classsynopsis> <para> - <function>mysqli_num_fields</function> returns the number of fields from specified result set. + Returns the number of fields from specified result set. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; - <para>The number of fields from a result set</para> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.result.description; + </variablelist> + </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_fetch_field</function>. + The number of fields from a result set. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -101,6 +109,16 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_fetch_field</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-num-rows"> <refnamediv> <refname>mysqli_num_rows</refname> + <refname>result->num_rows</refname> <refpurpose>Gets the number of rows in a result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>int</type><methodname>mysqli_num_rows</methodname> @@ -28,7 +30,17 @@ have been retrieved. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.result.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns number of rows in the result set. @@ -40,16 +52,8 @@ </para> </note> </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_affected_rows</function>, - <function>mysqli_store_result</function>, - <function>mysqli_use_result</function>&listendand; - <function>mysqli_query</function>. - </para> - </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -118,6 +122,19 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_affected_rows</function></member> + <member><function>mysqli_store_result</function></member> + <member><function>mysqli_use_result</function></member> + <member><function>mysqli_query</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-options"> <refnamediv> <refname>mysqli_options</refname> - <refname>mysqli->options</refname> + <refname>mysqli->options()</refname> <refpurpose>Set options</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_options</methodname> @@ -25,75 +26,105 @@ </methodsynopsis> </classsynopsis> <para> - <function>mysqli_options</function> can be used to set extra connect options - and affect behavior for a connection. + 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>. + <function>mysqli_options</function> should be called after + <function>mysqli_init</function> and before + <function>mysqli_real_connect</function>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <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_COMMAND</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> + <variablelist> + &mysqli.link.description; + <varlistentry> + <term><parameter>option</parameter></term> + <listitem> + <para> + The option that you want to set. It 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_COMMAND</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> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + The value for the option. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para>&return.success;</para> - </refsect1> - <refsect1> - &reftitle.seealso; <para> - <function>mysqli_init</function>&listendand; - <function>mysqli_real_connect</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; - <para>See <function>mysqli_real_connect</function>.</para> + <para> + See <function>mysqli_real_connect</function>. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_init</function></member> + <member><function>mysqli_real_connect</function></member> + </simplelist> + </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-param-count"> <refnamediv> <refname>mysqli_param_count</refname> <refpurpose>Alias for <function>mysqli_stmt_param_count</function></refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para> This function is an alias of <function>mysqli_stmt_param_count</function>. - For a detailled descripton see description of - <function>mysqli_stmt_param_count</function>. </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> <function>mysqli_param_count</function> is deprecated and will be removed. </para> </note> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_stmt_param_count</function>. + <simplelist> + <member><function>mysqli_stmt_param_count</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-ping"> <refnamediv> <refname>mysqli_ping</refname> - <refname>mysqli->ping</refname> + <refname>mysqli->ping()</refname> <refpurpose>Pings a server connection, or tries to reconnect if the connection has gone down</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_ping</methodname> @@ -32,11 +33,24 @@ necessary. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.link.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para>&return.success;</para> + <para> + &return.success; + </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -97,6 +111,7 @@ ]]> </screen> </refsect1> + </refentry>  + <refentry id="function.mysqli-prepare"> <refnamediv> <refname>mysqli_prepare</refname> - <refname>mysqli->prepare</refname> + <refname>mysqli->prepare()</refname> <refpurpose>Prepare a SQL statement for execution</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedure style:</para> <methodsynopsis> <type>mysqli_stmt</type><methodname>mysqli_prepare</methodname> @@ -23,63 +24,75 @@ </methodsynopsis> </classsynopsis> <para> - <function>mysqli_prepare</function> prepares the SQL query pointed to by the - null-terminated string query, and returns a statement handle to be used for - further operations on the statement. The query must consist of a single SQL statement. - </para> - <note> - <para> - You should not add a terminating semicolon or <literal>\g</literal> - to the statement. - </para> - </note> - <para> - The parameter <parameter>query</parameter> can include one or more parameter markers - in the SQL statement by embedding question mark (<literal>?</literal>) characters - at the appropriate positions. + Prepares the SQL query pointed to by the null-terminated string query, and + returns a statement handle to be used for further operations on the + statement. The query must consist of a single SQL statement. </para> - <note> - <para> - The markers are legal only in certain places in SQL statements. - For example, they are allowed in the VALUES() list of an INSERT statement - (to specify column values for a row), or in a comparison with a column in - a WHERE clause to specify a comparison value. - </para> - <para> - However, they are not allowed for identifiers (such as table or column names), - in the select list that names the columns to be returned by a SELECT statement, - or to specify both operands of a binary operator such as the <literal>=</literal> - equal sign. The latter restriction is necessary because it would be impossible - to determine the parameter type. It's not allowed to compare marker - with <literal>NULL</literal> by <literal>? IS NULL</literal> too. - In general, parameters are legal only in Data - Manipulation Languange (DML) statements, and not in Data Defination Language - (DDL) statements. - </para> - </note> <para> The parameter markers must be bound to application variables using - <function>mysqli_stmt_bind_param</function> and/or <function>mysqli_stmt_bind_result</function> - before executing the statement or fetching rows. + <function>mysqli_stmt_bind_param</function> and/or + <function>mysqli_stmt_bind_result</function> before executing the + statement or fetching rows. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>mysqli_prepare</function> returns a statement object or &false; if an error occured. + <variablelist> + &mysqli.link.description; + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + The query, as a string. + </para> + <note> + <para> + You should not add a terminating semicolon or <literal>\g</literal> + to the statement. + </para> + </note> + <para> + This parameter can include one or more parameter markers in the SQL + statement by embedding question mark (<literal>?</literal>) characters + at the appropriate positions. + </para> + <note> + <para> + The markers are legal only in certain places in SQL statements. + For example, they are allowed in the <literal>VALUES()</literal> + list of an <literal>INSERT</literal> statement (to specify column + values for a row), or in a comparison with a column in a + <literal>WHERE</literal> clause to specify a comparison value. + </para> + <para> + However, they are not allowed for identifiers (such as table or + column names), in the select list that names the columns to be + returned by a <literal>SELECT</literal> statement, or to specify both + operands of a binary operator such as the <literal>=</literal> equal + sign. The latter restriction is necessary because it would be + impossible to determine the parameter type. It's not allowed to + compare marker with <literal>NULL</literal> by + <literal>? IS NULL</literal> too. In general, parameters are legal + only in Data Manipulation Languange (DML) statements, and not in Data + Defination Language (DDL) statements. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_stmt_execute</function>, - <function>mysqli_stmt_fetch</function>, - <function>mysqli_stmt_bind_param</function>, - <function>mysqli_stmt_bind_result</function>&listendand; - <function>mysqli_stmt_close</function>. + <function>mysqli_prepare</function> returns a statement object or &false; if an error occured. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -172,6 +185,20 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_stmt_execute</function></member> + <member><function>mysqli_stmt_fetch</function></member> + <member><function>mysqli_stmt_bind_param</function></member> + <member><function>mysqli_stmt_bind_result</function></member> + <member><function>mysqli_stmt_close</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-query"> <refnamediv> <refname>mysqli_query</refname> - <refname>mysqli->query</refname> + <refname>mysqli->query()</refname> <refpurpose>Performs a query on the database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>mixed</type><methodname>mysqli_query</methodname> @@ -25,29 +26,49 @@ </methodsynopsis> </classsynopsis> <para> - The <function>mysqli_query</function> function is used to simplify the - act of performing a query against the database represented by the - <parameter>link</parameter> parameter. + Performs a <parameter>query</parameter> against the database. </para> <para> - Functionally, using this - function is identical to calling <function>mysqli_real_query</function> - followed either by <function>mysqli_use_result</function> or - <function>mysqli_store_result</function> where <parameter>query</parameter> - is the query string itself and <parameter>resultmode</parameter> is - either the constant <literal>MYSQLI_USE_RESULT</literal> or - <literal>MYSQLI_STORE_RESULT</literal> depending - on the desired behavior. By default, if the - <parameter>resultmode</parameter> is not provided - <literal>MYSQLI_STORE_RESULT</literal> is used. + Functionally, using this function is identical to calling + <function>mysqli_real_query</function> followed either by + <function>mysqli_use_result</function> or + <function>mysqli_store_result</function>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - If you execute <function>mysqli_query</function> with <parameter>resultmode</parameter> - <literal>MYSQLI_USE_RESULT</literal> all subsequent calls will return error - <literal>Commands out of sync</literal> unless you call <function>mysqli_free_result</function>. + <variablelist> + &mysqli.link.description; + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + The query string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>resultmode</parameter></term> + <listitem> + <para> + Either the constant <constant>MYSQLI_USE_RESULT</constant> or + <constant>MYSQLI_STORE_RESULT</constant> depending on the desired + behavior. By default, <constant>MYSQLI_STORE_RESULT</constant> is used. + </para> + <para> + If you use <constant>MYSQLI_USE_RESULT</constant> all subsequent calls + will return error <literal>Commands out of sync</literal> unless you + call <function>mysqli_free_result</function> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; For <literal>SELECT, SHOW, DESCRIBE</literal> or @@ -55,15 +76,8 @@ a result object. </para> </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_real_query</function>, - <function>mysqli_multi_query</function>&listendand; - <function>mysqli_free_result</function>. - </para> - </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -160,6 +174,18 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_real_query</function></member> + <member><function>mysqli_multi_query</function></member> + <member><function>mysqli_free_result</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-real-connect"> <refnamediv> <refname>mysqli_real_connect</refname> - <refname>mysqli->real_connect</refname> + <refname>mysqli->real_connect()</refname> <refpurpose>Opens a connection to a mysql server</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style</para> <methodsynopsis> <type>bool</type><methodname>mysqli_real_connect</methodname> <methodparam><type>mysqli</type><parameter>link</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>host</parameter></methodparam> <methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam> <methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam> <methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam> @@ -25,7 +26,7 @@ <ooclass><classname>mysqli</classname></ooclass> <methodsynopsis> <type>bool</type><methodname>real_connect</methodname> - <methodparam choice='opt'><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>host</parameter></methodparam> <methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam> <methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam> <methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam> @@ -35,9 +36,7 @@ </methodsynopsis> </classsynopsis> <para> - <function>mysqli_real_connect</function> attempts to establish a - connection to a MySQL database engine running on - <parameter>hostname</parameter>. + Establish a connection to a MySQL database engine. </para> <para> This function differs from <function>mysqli_connect</function>: @@ -51,74 +50,151 @@ </listitem> <listitem> <para> - With function <function>mysqli_options</function> you can set various options for connection. + With function <function>mysqli_options</function> you can set various + options for connection. </para> </listitem> <listitem> <para> - With the parameter <parameter>flags</parameter> you can set different connection options: + There is a <parameter>flags</parameter> parameter. </para> - <table> - <title>Supported flags</title> - <tgroup cols='2'> - <thead> - <row> - <entry>Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>MYSQLI_CLIENT_COMPRESS</literal></entry> - <entry>Use compression protocol</entry> - </row> - <row> - <entry><literal>MYSQLI_CLIENT_FOUND_ROWS</literal></entry> - <entry>return number of matched rows, not the number of affected rows</entry> - </row> - <row> - <entry><literal>MYSQLI_CLIENT_IGNORE_SPACE</literal></entry> - <entry>Allow spaces after function names. Makes all function names reserved words.</entry> - </row> - <row> - <entry><literal>MYSQLI_CLIENT_INTERACTIVE</literal></entry> - <entry> - Allow <literal>interactive_timeout</literal> seconds (instead of - <literal>wait_timeout</literal> seconds) of inactivity before closing the connection - </entry> - </row> - <row> - <entry><literal>MYSQLI_CLIENT_SSL</literal></entry> - <entry>Use SSL (encryption)</entry> - </row> - </tbody> - </tgroup> - </table> - <note> - <para> - For security reasons the <literal>MULTI_STATEMENT</literal> flag is not supported in - PHP. If you want to execute multiple queries use the - <function>mysqli_multi_query</function> function. - </para> - </note> </listitem> </itemizedlist> </refsect1> - <refsect1> - &reftitle.returnvalues; - <para>&return.success;</para> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.link.description; + <varlistentry> + <term><parameter>host</parameter></term> + <listitem> + <para> + Can be either a host name or an IP address. Passing the &null; value + or the string "localhost" to this parameter, the local host is + assumed. When possible, pipes will be used instead of the TCP/IP + protocol. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The MySQL user name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>passwd</parameter></term> + <listitem> + <para> + If provided or &null;, the MySQL server will attempt to authenticate + the user against those user records which have no password only. This + allows one username to be used with different permissions (depending + on if a password as provided or not). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dbname</parameter></term> + <listitem> + <para> + If provided will specify the default database to be used when + performing queries. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>port</parameter></term> + <listitem> + <para> + Specifies the port number to attempt to connect to the MySQL server. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>socket</parameter></term> + <listitem> + <para> + Specifies the socket or named pipe that should be used. + </para> + <note> + <para> + Specifying the <parameter>socket</parameter> parameter will not + explicitly determine the type of connection to be used when + connecting to the MySQL server. How the connection is made to the + MySQL database is determined by the <parameter>host</parameter> + parameter. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem> + <para> + With the parameter <parameter>flags</parameter> you can set different + connection options: + </para> + <table> + <title>Supported flags</title> + <tgroup cols='2'> + <thead> + <row> + <entry>Name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>MYSQLI_CLIENT_COMPRESS</constant></entry> + <entry>Use compression protocol</entry> + </row> + <row> + <entry><constant>MYSQLI_CLIENT_FOUND_ROWS</constant></entry> + <entry>return number of matched rows, not the number of affected rows</entry> + </row> + <row> + <entry><constant>MYSQLI_CLIENT_IGNORE_SPACE</constant></entry> + <entry>Allow spaces after function names. Makes all function names reserved words.</entry> + </row> + <row> + <entry><constant>MYSQLI_CLIENT_INTERACTIVE</constant></entry> + <entry> + Allow <literal>interactive_timeout</literal> seconds (instead of + <literal>wait_timeout</literal> seconds) of inactivity before closing the connection + </entry> + </row> + <row> + <entry><constant>MYSQLI_CLIENT_SSL</constant></entry> + <entry>Use SSL (encryption)</entry> + </row> + </tbody> + </tgroup> + </table> + <note> + <para> + For security reasons the <constant>MULTI_STATEMENT</constant> flag is + not supported in PHP. If you want to execute multiple queries use the + <function>mysqli_multi_query</function> function. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_connect</function>, - <function>mysqli_init</function>, - <function>mysqli_options</function>, - <function>mysqli_ssl_set</function>&listendand; - <function>mysqli_close</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -186,6 +262,20 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_connect</function></member> + <member><function>mysqli_init</function></member> + <member><function>mysqli_options</function></member> + <member><function>mysqli_ssl_set</function></member> + <member><function>mysqli_close</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-real-escape-string"> <refnamediv> <refname>mysqli_real_escape_string</refname> - <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> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>string</type><methodname>mysqli_real_escape_string</methodname> @@ -27,27 +28,41 @@ </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. + This function is used to create a legal SQL string that you can use in an + SQL statement. The given string is encoded to an escaped SQL string, + taking into account the current character set of the connection. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Characters encoded are <literal>NUL (ASCII 0), \n, \r, \, ', ", and Control-Z</literal>. + <variablelist> + &mysqli.link.description; + <varlistentry> + <term><parameter>escapestr</parameter></term> + <listitem> + <para> + The string to be escaped. + </para> + <para> + Characters encoded are <literal>NUL (ASCII 0), \n, \r, \, ', ", and + Control-Z</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns an escaped string. </para> </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_character_set_name</function>. - </para> - </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -125,6 +140,16 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_character_set_name</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-real-query"> <refnamediv> <refname>mysqli_real_query</refname> - <refname>mysqli->real_query</refname> + <refname>mysqli->real_query()</refname> <refpurpose>Execute an SQL query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style</para> <methodsynopsis> <type>bool</type><methodname>mysqli_real_query</methodname> @@ -23,33 +24,51 @@ </methodsynopsis> </classsynopsis> <para> - The <function>mysqli_real_query</function> function is used to execute - only a query against the database represented by the <parameter>link</parameter> - whose result can then be retrieved or stored using the - <function>mysqli_store_result</function> or <function>mysqli_use_result</function> - functions. + Executes a single query against the database whose result can then be + retrieved or stored using the <function>mysqli_store_result</function> or + <function>mysqli_use_result</function> functions. + </para> + <para> + In order to determine if a given query should return a result set or not, + see <function>mysqli_field_count</function>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.link.description; + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + The query, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> </para> - <note> - <para> - In order to determine if a given query should return a result set or not, - see <function>mysqli_field_count</function>. - </para> - </note> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_query</function>, - <function>mysqli_store_result</function>&listendand; - <function>mysqli_use_result</function>. + <simplelist> + <member><function>mysqli_query</function></member> + <member><function>mysqli_store_result</function></member> + <member><function>mysqli_use_result</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-report"> <refnamediv> <refname>mysqli_report</refname> <refpurpose>Enables or disables internal report functions</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mysqli_report</methodname> <methodparam><type>int</type><parameter>flags</parameter></methodparam> @@ -17,52 +18,64 @@ errors from mysqli function calls or queries which don't use an index (or use a bad index). </para> - <table> - <title>Supported flags</title> - <tgroup cols='2'> - <thead> - <row> - <entry>Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>MYSQLI_REPORT_OFF</literal></entry> - <entry>Turns reporting off</entry> - </row> - <row> - <entry><literal>MYSQLI_REPORT_ERROR</literal></entry> - <entry>Report errors from mysqli function calls</entry> - </row> - <row> - <entry><literal>MYSQLI_REPORT_STRICT</literal></entry> - <entry>Report warnings from mysqli function calls</entry> - </row> - <row> - <entry><literal>MYSQLI_REPORT_INDEX</literal></entry> - <entry>Report if no index or bad index was used in a query</entry> - </row> - <row> - <entry><literal>MYSQLI_REPORT_ALL</literal></entry> - <entry>Set all options (report all)</entry> - </row> - </tbody> - </tgroup> - </table> </refsect1> - <refsect1> - &reftitle.returnvalues; - <para>&return.success;</para> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem> + <para> + <table> + <title>Supported flags</title> + <tgroup cols='2'> + <thead> + <row> + <entry>Name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>MYSQLI_REPORT_OFF</constant></entry> + <entry>Turns reporting off</entry> + </row> + <row> + <entry><constant>MYSQLI_REPORT_ERROR</constant></entry> + <entry>Report errors from mysqli function calls</entry> + </row> + <row> + <entry><constant>MYSQLI_REPORT_STRICT</constant></entry> + <entry>Report warnings from mysqli function calls</entry> + </row> + <row> + <entry><constant>MYSQLI_REPORT_INDEX</constant></entry> + <entry>Report if no index or bad index was used in a query</entry> + </row> + <row> + <entry><constant>MYSQLI_REPORT_ALL</constant></entry> + <entry>Set all options (report all)</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_debug</function>&listendand; - <function>mysqli_dump_debug_info</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <para> <example> @@ -95,6 +108,17 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_debug</function></member> + <member><function>mysqli_dump_debug_info</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-rollback"> <refnamediv> <refname>mysqli_rollback</refname> - <refname>mysqli->rollback</refname> + <refname>mysqli->rollback()</refname> <refpurpose>Rolls back current transaction</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mysqli_rollback</methodname> <methodparam><type>mysqli</type><parameter>link</parameter></methodparam> @@ -20,24 +21,27 @@ </methodsynopsis> </classsynopsis> <para> - Rollbacks the current transaction for the database specified by the - <parameter>link</parameter> parameter. + Rollbacks the current transaction for the database. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success; + <variablelist> + &mysqli.link.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_commit</function>&listendand; - <function>mysqli_autocommit</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -149,6 +153,17 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_commit</function></member> + <member><function>mysqli_autocommit</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-rpl-parse-enabled"> <refnamediv> <refname>mysqli_rpl_parse_enabled</refname> <refpurpose>Check if RPL parse is enabled</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>mysqli_rpl_parse_enabled</methodname> <methodparam><type>mysqli</type><parameter>link</parameter></methodparam> @@ -15,6 +16,7 @@ &warn.undocumented.func; </refsect1> + </refentry>  + <refentry id="function.mysqli-rpl-probe"> <refnamediv> <refname>mysqli_rpl_probe</refname> <refpurpose>RPL probe</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mysqli_rpl_probe</methodname> <methodparam><type>mysqli</type><parameter>link</parameter></methodparam> @@ -15,6 +16,7 @@ &warn.undocumented.func; </refsect1> + </refentry>  + <refentry id="function.mysqli-rpl-query-type"> <refnamediv> <refname>mysqli_rpl_query_type</refname> - <refname>mysqli->rpl_query_type</refname> + <refname>mysqli->rpl_query_type()</refname> <refpurpose>Returns RPL query type</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>int</type><methodname>mysqli_rpl_query_type</methodname> @@ -36,6 +37,7 @@ &warn.undocumented.func; </refsect1> + </refentry>  + <refentry id="function.mysqli-select-db"> <refnamediv> <refname>mysqli_select_db</refname> <refname>mysqli->select_db</refname> <refpurpose>Selects the default database for database queries</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mysqli_select_db</methodname> <methodparam><type>mysqli</type><parameter>link</parameter></methodparam> <methodparam><type>string</type><parameter>dbname</parameter></methodparam> </methodsynopsis> <para> - The <function>mysqli_select_db</function> function selects the default - database (specified by the <parameter>dbname</parameter> parameter) to be - used when performing queries against the database connection - represented by the <parameter>link</parameter> parameter. + Selects the default database to be used when performing queries against + the database connection. </para> <note> <para> - This function should only be used to change the default database for the connection. - You can select the default database with 4th parameter in <function>mysqli_connect</function>. + This function should only be used to change the default database for the + connection. You can select the default database with 4th parameter in + <function>mysqli_connect</function>. </para> </note> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success; + <variablelist> + &mysqli.link.description; + <varlistentry> + <term><parameter>dbname</parameter></term> + <listitem> + <para> + The database name. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_connect</function>&listendand; - <function>mysqli_real_connect</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -119,6 +131,17 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_connect</function></member> + <member><function>mysqli_real_connect</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-send-long-data"> <refnamediv> <refname>mysqli_send_long_data</refname> <refpurpose>Alias for <function>mysqli_stmt_send_long_data</function></refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para> This function is an alias of <function>mysqli_stmt_send_long_data</function>. - For a detailled descripton see description of - <function>mysqli_stmt_send_long_data</function>. </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <para> <function>mysqli_send_long_data</function> is deprecated and will be removed. </para> </note> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_stmt_send_long_data</function>. + <simplelist> + <member><function>mysqli_stmt_send_long_data</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-send-query"> <refnamediv> <refname>mysqli_send_query</refname> - <refname>mysqli->send_query</refname> + <refname>mysqli->send_query()</refname> <refpurpose>Send the query and return</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_send_query</methodname> @@ -26,6 +27,7 @@ &warn.undocumented.func; </refsect1> + </refentry>  + <refentry id="function.mysqli-server-end"> <refnamediv> <refname>mysqli_server_end</refname> <refpurpose>Shut down the embedded server</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>mysqli_server_end</methodname> <void/> @@ -15,6 +16,7 @@ &warn.undocumented.func; </refsect1> + </refentry>  + <refentry id="function.mysqli-server-init"> <refnamediv> <refname>mysqli_server_init</refname> <refpurpose>Initialize embedded server</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mysqli_server_init</methodname> <methodparam choice="opt"><type>array</type><parameter>server</parameter></methodparam> @@ -16,6 +17,7 @@ &warn.undocumented.func; </refsect1> + </refentry>  + <refentry id="function.mysqli-set-charset"> <refnamediv> <refname>mysqli_set_charset</refname> <refname>mysqli->set_charset</refname> <refpurpose>Sets the default client character set</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mysqli_set_charset</methodname> <methodparam><type>mysqli</type><parameter>link</parameter></methodparam> <methodparam><type>string</type><parameter>charset</parameter></methodparam> </methodsynopsis> <para> - The <function>mysqli_set_charset</function> function sets the default - character set (specified by the <parameter>charset</parameter> parameter) to be - used when sending data from and to the database server - represented by the <parameter>link</parameter> parameter. + Sets the default character set to be used when sending data from and to + the database server. </para> - <note> - <para> - To use this function on a Windows platform you need MySQL client library version 4.1.11 - or above (for MySQL 5.0 you need 5.0.6 or above). It can be downloaded at - <ulink url="&url.mysql.download.lib;">&url.mysql.download.lib;</ulink>. - </para> - </note> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success; + <variablelist> + &mysqli.link.description; + <varlistentry> + <term><parameter>charset</parameter></term> + <listitem> + <para> + The charset to be set as default. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_character_set_name</function>&listendand; - <function>mysqli_real_escape_string</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + To use this function on a Windows platform you need MySQL client library + version 4.1.11 or above (for MySQL 5.0 you need 5.0.6 or above). It can + be downloaded at + <ulink url="&url.mysql.download.lib;">&url.mysql.download.lib;</ulink>. + </para> + </note> + </refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -99,6 +115,17 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_character_set_name</function></member> + <member><function>mysqli_real_escape_string</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-set-opt"> <refnamediv> <refname>mysqli_set_opt</refname> <refpurpose>Alias of <function>mysqli_options</function></refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para> This function is an alias of <function>mysqli_options</function>. </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-sqlstate"> <refnamediv> <refname>mysqli_sqlstate</refname> <refname>mysqli->sqlstate</refname> <refpurpose>Returns the SQLSTATE error from previous MySQL operation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>string</type><methodname>mysqli_sqlstate</methodname> @@ -31,21 +32,25 @@ </para> </note> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Returns a string containing the SQLSTATE error code for the last error. - The error code consists of five characters. <literal>'00000'</literal> means no error. + <variablelist> + &mysqli.link.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_errno</function>&listendand; - <function>mysqli_error</function>. + Returns a string containing the SQLSTATE error code for the last error. + The error code consists of five characters. <literal>'00000'</literal> means no error. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -100,6 +105,17 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_errno</function></member> + <member><function>mysqli_error</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-ssl-set"> <refnamediv> <refname>mysqli_ssl_set</refname> - <refname>mysqli->ssl_set</refname> + <refname>mysqli->ssl_set()</refname> <refpurpose>Used for establishing secure connections using SSL</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_ssl_set</methodname> @@ -31,37 +32,84 @@ </methodsynopsis> </classsynopsis> <para> - The function <function>mysqli_ssl_set</function> is used for establishing - secure connections using SSL. It must be called before - <function>mysqli_real_connect</function>. This function does nothing - unless OpenSSL support is enabled. + Used for establishing secure connections using SSL. It must be called + before <function>mysqli_real_connect</function>. This function does + nothing unless OpenSSL support is enabled. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.link.description; + <varlistentry> + <term><parameter>key</parameter></term> + <listitem> + <para> + The path name to the key file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>cert</parameter></term> + <listitem> + <para> + The path name to the certificate file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ca</parameter></term> + <listitem> + <para> + The path name to the certificate authority file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>capath</parameter></term> + <listitem> + <para> + The pathname to a directory that contains trusted SSL CA certificates + in PEM format. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>cipher</parameter></term> + <listitem> + <para> + A list of allowable ciphers to use for SSL encryption. + </para> + </listitem> + </varlistentry> + </variablelist> </para> <para> - <parameter>key</parameter> is the pathname to the key file. - <parameter>cert</parameter> is the pathname to the certificate file. - <parameter>ca</parameter> is the pathname to the certificate authority file. - <parameter>capath</parameter> is the pathname to a directory that contains - trusted SSL CA certificates in pem format. - <parameter>cipher</parameter> is a list of allowable ciphers to use for - SSL encryption. Any unused SSL parameters may be given as &null; </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - This function always returns &true; value. If SSL setup is - incorrect <function>mysqli_real_connect</function> will return an error - when you attempt to connect. + This function always returns &true; value. If SSL setup is + incorrect <function>mysqli_real_connect</function> will return an error + when you attempt to connect. </para> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_options</function>&listendand; - <function>mysqli_real_connect</function>. + <simplelist> + <member><function>mysqli_options</function></member> + <member><function>mysqli_real_connect</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-stat"> <refnamediv> <refname>mysqli_stat</refname> - <refname>mysqli->stat</refname> + <refname>mysqli->stat()</refname> <refpurpose>Gets the current system status</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>string</type><methodname>mysqli_stat</methodname> @@ -28,19 +29,24 @@ questions, reloads, and open tables. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - A string describing the server status. &false; if an error occurred. + <variablelist> + &mysqli.link.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_get_server_info</function>. + A string describing the server status. &false; if an error occurred. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -91,6 +97,16 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_get_server_info</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-affected-rows"> <refnamediv> <refname>mysqli_stmt_affected_rows</refname> @@ -8,8 +8,9 @@ inserted by the last executed statement </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style :</para> <methodsynopsis> <type>int</type><methodname>mysqli_stmt_affected_rows</methodname> @@ -21,38 +22,43 @@ <fieldsynopsis><type>int</type><varname>affected_rows</varname></fieldsynopsis> </classsynopsis> <para> - <function>mysqli_stmt_affected_rows</function> returns the number of rows affected - by INSERT, UPDATE, or DELETE query. If the last query was invalid, this function will return -1. + Returns the number of rows affected by <literal>INSERT</literal>, + <literal>UPDATE</literal>, or <literal>DELETE</literal> query. + </para> + <para> + This function only works with queries which update a table. In order to + get the number of rows from a SELECT query, use + <function>mysqli_stmt_num_rows</function> instead. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The <function>mysqli_stmt_affected_rows</function> function only works with queries - which update a table. In order to return the number of rows from a SELECT query, use - the <function>mysqli_stmt_num_rows</function> function instead. + <variablelist> + &mysqli.stmt.description; + </variablelist> </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - An integer greater than zero indicates the number of rows affected or retrieved. - Zero indicates that no records where updated for an UPDATE/DELETE statement, no - rows matched the WHERE clause in the query or that no query has yet been executed. - -1 indicates that the query has returned an error. + An integer greater than zero indicates the number of rows affected or + retrieved. + Zero indicates that no records where updated for an UPDATE/DELETE + statement, no rows matched the WHERE clause in the query or that no query + has yet been executed. -1 indicates that the query has returned an error. </para> <note> <para> - If the number of affected rows is greater than maximal PHP int value, the number of - affected rows will be returned as a string value. + If the number of affected rows is greater than maximal PHP int value, the + number of affected rows will be returned as a string value. </para> </note> </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_stmt_num_rows</function>&listendand; - <function>mysqli_prepare</function>. - </para> - </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -141,6 +147,17 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_stmt_num_rows</function></member> + <member><function>mysqli_prepare</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-bind-param"> <refnamediv> <refname>mysqli_stmt_bind_param</refname> - <refname>stmt->bind_param</refname> + <refname>stmt->bind_param()</refname> <refpurpose>Binds variables to a prepared statement as parameters</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_stmt_bind_param</methodname> @@ -27,73 +28,83 @@ </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 sent in packets</entry> - </row> - </tbody> - </tgroup> - </table> + Bind variables for the parameter markers in the SQL statement that was + passed to <function>mysqli_prepare</function>. </para> <note> - <para> - If data size of a variable exceeds max. allowed packet size - (max_allowed_packet), 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 packets. - </para> - <para> - The number of variables and length of - string <parameter>types</parameter> must match the parameters in the statement. + <para> + If data size of a variable exceeds max. allowed packet size + (max_allowed_packet), 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 packets. </para> </note> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success; + <variablelist> + &mysqli.stmt.description; + <varlistentry> + <term><parameter>types</parameter></term> + <listitem> + <para> + A string that 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 sent in packets</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>var1</parameter></term> + <listitem> + <para> + The number of variables and length of string + <parameter>types</parameter> must match the parameters in the statement. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <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>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -181,6 +192,22 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_stmt_bind_result</function></member> + <member><function>mysqli_stmt_execute</function></member> + <member><function>mysqli_stmt_fetch</function></member> + <member><function>mysqli_prepare</function></member> + <member><function>mysqli_stmt_send_long_data</function></member> + <member><function>mysqli_stmt_errno</function></member> + <member><function>mysqli_stmt_error</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-bind-result"> <refnamediv> <refname>mysqli_stmt_bind_result</refname> - <refname>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> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_stmt_bind_result</methodname> @@ -25,43 +26,54 @@ </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>. + Binds columns in the result set to variables. + </para> + <para> + 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 after <function>mysqli_stmt_execute</function> and prior to calling + Note that all columns must be bound after + <function>mysqli_stmt_execute</function> and prior to calling <function>mysqli_stmt_fetch</function>. - Depending on column types bound variables can silently change to the corresponding PHP type. + 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. + 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; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success; + <variablelist> + &mysqli.stmt.description; + <varlistentry> + <term><parameter>var1</parameter></term> + <listitem> + <para> + The variable to be bound. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <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>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -143,6 +155,23 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_stmt_bind_param</function></member> + <member><function>mysqli_stmt_execute</function></member> + <member><function>mysqli_stmt_fetch</function></member> + <member><function>mysqli_prepare</function></member> + <member><function>mysqli_stmt_prepare</function></member> + <member><function>mysqli_stmt_init</function></member> + <member><function>mysqli_stmt_errno</function></member> + <member><function>mysqli_stmt_error</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-close"> <refnamediv> <refname>mysqli_stmt_close</refname> - <refname>mysqli_stmt->close</refname> + <refname>mysqli_stmt->close()</refname> <refpurpose>Closes a prepared statement</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_stmt_close</methodname> @@ -22,22 +23,38 @@ </methodsynopsis> </classsynopsis> <para> - Closes a prepared statement. <function>mysqli_stmt_close</function> also deallocates the - statement handle pointed to by <parameter>stmt</parameter>. - If the current statement has pending or unread results, this function cancels them so that - the next query can be executed. + Closes a prepared statement. <function>mysqli_stmt_close</function> also + deallocates the statement handle. If the current statement has pending or + unread results, this function cancels them so that the next query can be + executed. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.stmt.description; + </variablelist> </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para>&return.success;</para> + <para> + &return.success; + </para> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_prepare</function>. + <simplelist> + <member><function>mysqli_prepare</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-data-seek"> <refnamediv> <refname>mysqli_stmt_data_seek</refname> - <refname>stmt->data_seek</refname> + <refname>stmt->data_seek()</refname> <refpurpose>Seeks to an arbitray row in statement result set</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>void</type><methodname>mysqli_stmt_data_seek</methodname> - <methodparam><type>mysqli_stmt</type><parameter>statement</parameter></methodparam> + <methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam> <methodparam><type>int</type><parameter>offset</parameter></methodparam> </methodsynopsis> <para>Object oriented style (method):</para> @@ -23,25 +24,36 @@ </methodsynopsis> </classsynopsis> <para> - The <function>mysqli_stmt_data_seek</function> function seeks to an arbitrary result pointer - specified by the <parameter>offset</parameter> in the statement result set represented by - <parameter>statement</parameter>. The <parameter>offset</parameter> parameter must be between - zero and the total number of rows minus one (0..<function>mysqli_stmt_num_rows</function> - 1). + Seeks to an arbitrary result pointer in the statement result set. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Returns &null; on success or &false; on failure. + <variablelist> + &mysqli.stmt.description; + <varlistentry> + <term><parameter>offset</parameter></term> + <listitem> + <para> + Must be between zero and the total number of rows minus one (0.. + <function>mysqli_stmt_num_rows</function> - 1). + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_prepare</function>. + &return.void; </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -138,6 +150,16 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_prepare</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-errno"> <refnamediv> <refname>mysqli_stmt_errno</refname> <refname>mysqli_stmt->errno</refname> <refpurpose>Returns the error code for the most recent statement call</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style :</para> <methodsynopsis> <type>int</type><methodname>mysqli_stmt_errno</methodname> @@ -19,32 +20,37 @@ <fieldsynopsis><type>int</type><varname>errno</varname></fieldsynopsis> </classsynopsis> <para> - For the statement specified by <literal>stmt</literal>, <function>mysqli_stmt_errno</function> - returns the error code for the most recently invoked statement function that can succeed or fail. + Returns the error code for the most recently invoked statement function + that can succeed or fail. + </para> + <para> + Client error message numbers are listed in the MySQL + <filename>errmsg.h</filename> header file, + server error message numbers are listed in + <filename>mysqld_error.h</filename>. + In the MySQL source distribution you can find a complete list of error + messages and error numbers in the file + <filename>Docs/mysqld_error.txt</filename>. </para> - <note> - <para> - Client error message numbers are listed in the MySQL <filename>errmsg.h</filename> header file, - server error message numbers are listed in <filename>mysqld_error.h</filename>. - In the MySQL source distribution you can find a complete list of error messages and error numbers - in the file <filename>Docs/mysqld_error.txt</filename>. - </para> - </note> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - An error code value. Zero means no error occurred. + <variablelist> + &mysqli.stmt.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_stmt_error</function>&listendand; - <function>mysqli_stmt_sqlstate</function>. + An error code value. Zero means no error occurred. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -131,6 +137,17 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_stmt_error</function></member> + <member><function>mysqli_stmt_sqlstate</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-error"> <refnamediv> <refname>mysqli_stmt_error</refname> <refname>mysqli_stmt->error</refname> <refpurpose>Returns a string description for last statement error</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>string</type><methodname>mysqli_stmt_error</methodname> @@ -19,25 +20,28 @@ <fieldsynopsis><type>string</type><varname>error</varname></fieldsynopsis> </classsynopsis> <para> - For the statement specified by <literal>stmt</literal>, <function>mysqli_stmt_error</function> - returns a containing the error message for the most recently invoked statement function that - can succeed or fail. + Returns a containing the error message for the most recently invoked + statement function that can succeed or fail. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - A string that describes the error. An empty string if no error occurred. + <variablelist> + &mysqli.stmt.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_stmt_errno</function>&listendand; - <function>mysqli_stmt_sqlstate</function>. + A string that describes the error. An empty string if no error occurred. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -124,6 +128,17 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_stmt_errno</function></member> + <member><function>mysqli_stmt_sqlstate</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-execute"> <refnamediv> <refname>mysqli_stmt_execute</refname> - <refname>stmt->execute</refname> + <refname>stmt->execute()</refname> <refpurpose>Executes a prepared Query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_stmt_execute</methodname> @@ -22,37 +23,44 @@ </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. + Executes a query that has been previously prepared using the + <function>mysqli_prepare</function> function. 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. + If the statement is <literal>UPDATE</literal>, <literal>DELETE</literal>, + or <literal>INSERT</literal>, 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. + 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; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success; + <variablelist> + &mysqli.stmt.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_prepare</function>&listendand; - <function>mysqli_stmt_bind_param</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -176,6 +184,17 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_prepare</function></member> + <member><function>mysqli_stmt_bind_param</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-fetch"> <refnamediv> <refname>mysqli_stmt_fetch</refname> - <refname>stmt->fetch</refname> + <refname>stmt->fetch()</refname> <refpurpose>Fetch results from a prepared statement into the bound variables</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_stmt_fetch</methodname> @@ -22,8 +23,7 @@ </methodsynopsis> </classsynopsis> <para> - <function>mysqli_stmt_fetch</function> fetch the result from a prepared - statement into the variables bound by + Fetch the result from a prepared statement into the variables bound by <function>mysqli_stmt_bind_result</function>. </para> <note> @@ -33,7 +33,17 @@ </para> </note> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.stmt.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <table> &reftitle.returnvalues; @@ -54,23 +64,15 @@ <entry>Error occured</entry> </row> <row> - <entry><literal>&null;</literal></entry> + <entry>&null;</entry> <entry>No more rows/data exists or data truncation occurred</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> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -159,6 +161,19 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_prepare</function></member> + <member><function>mysqli_stmt_errno</function></member> + <member><function>mysqli_stmt_error</function></member> + <member><function>mysqli_stmt_bind_result</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-free-result"> <refnamediv> <refname>mysqli_stmt_free_result</refname> - <refname>stmt->free_result</refname> + <refname>stmt->free_result()</refname> <refpurpose>Frees stored result memory for the given statement handle</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>void</type><methodname>mysqli_stmt_free_result</methodname> @@ -22,22 +23,33 @@ </methodsynopsis> </classsynopsis> <para> - The <function>mysqli_stmt_free_result</function> function frees the result memory - associated with the statement represented by the - <parameter>stmt</parameter> parameter, which was allocated by + Frees the result memory associated with the statement, which was allocated by <function>mysqli_stmt_store_result</function>. </para> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.stmt.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - This function doesn't return any value. + &return.void; </para> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_stmt_store_result</function>. + <simplelist> + <member><function>mysqli_stmt_store_result</function></member> + </simplelist> </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mysqli/functions/mysqli-stmt-init.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/mysqli/functions/mysqli-stmt-init.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-stmt-init.xml:1.7 phpdoc/en/reference/mysqli/functions/mysqli-stmt-init.xml:1.8 --- phpdoc/en/reference/mysqli/functions/mysqli-stmt-init.xml:1.7 Sat Jan 27 17:37:36 2007 +++ phpdoc/en/reference/mysqli/functions/mysqli-stmt-init.xml Sun Jan 28 04:25:58 2007 @@ -1,13 +1,14 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.mysqli-stmt-init"> <refnamediv> <refname>mysqli_stmt_init</refname> - <refname>mysqli->stmt_init</refname> + <refname>mysqli->stmt_init()</refname> <refpurpose>Initializes a statement and returns an object for use with mysqli_stmt_prepare</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style :</para> <methodsynopsis> <type>mysqli_stmt</type><methodname>mysqli_stmt_init</methodname> @@ -32,18 +33,32 @@ </para> </note> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.link.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns an object. </para> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_stmt_prepare</function>. + <simplelist> + <member><function>mysqli_stmt_prepare</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-num-rows"> <refnamediv> <refname>mysqli_stmt_num_rows</refname> <refname>stmt->num_rows</refname> <refpurpose>Return the number of rows in statements result set</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style :</para> <methodsynopsis> <type>int</type><methodname>mysqli_stmt_num_rows</methodname> @@ -30,21 +31,24 @@ <function>mysqli_stmt_num_rows</function> may be called immediately. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - An integer representing the number of rows in result set. + <variablelist> + &mysqli.stmt.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_stmt_affected_rows</function>, - <function>mysqli_prepare</function>&listendand; - <function>mysqli_stmt_store_result</function>. + An integer representing the number of rows in result set. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -123,6 +127,18 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_stmt_affected_rows</function></member> + <member><function>mysqli_prepare</function></member> + <member><function>mysqli_stmt_store_result</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <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> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>int</type><methodname>mysqli_stmt_param_count</methodname> @@ -19,23 +20,27 @@ <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. + Returns the number of parameter markers present in the prepared statement. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - returns an integer representing the number of parameters. + <variablelist> + &mysqli.stmt.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_prepare</function>. + Returns an integer representing the number of parameters. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -100,6 +105,16 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_prepare</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-prepare"> <refnamediv> <refname>mysqli_stmt_prepare</refname> - <refname>stmt->prepare</refname> + <refname>stmt->prepare()</refname> <refpurpose>Prepare a SQL statement for execution</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedure style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_stmt_prepare</methodname> @@ -19,67 +20,73 @@ <ooclass><classname>mysqli_stmt</classname></ooclass> <methodsynopsis> <type>mixed</type><methodname>prepare</methodname> - <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> </methodsynopsis> </classsynopsis> <para> - <function>mysqli_stmt_prepare</function> prepares the SQL query pointed to by the - null-terminated string query. The statement object has to be allocated by - <function>mysqli_stmt_init</function>. - The query must consist of a single SQL statement. - </para> - <note> - <para> - You should not add a terminating semicolon or <literal>\g</literal> - to the statement. - </para> - </note> - <para> - The parameter <parameter>query</parameter> can include one or more parameter markers - in the SQL statement by embedding question mark (<literal>?</literal>) characters - at the appropriate positions. + Prepares the SQL query pointed to by the null-terminated string query. </para> - <note> - <para> - The markers are legal only in certain places in SQL statements. - For example, they are allowed in the VALUES() list of an INSERT statement - (to specify column values for a row), or in a comparison with a column in - a WHERE clause to specify a comparison value. - </para> - <para> - However, they are not allowed for identifiers (such as table or column names), - in the select list that names the columns to be returned by a SELECT statement), - or to specify both operands of a binary operator such as the <literal>=</literal> - equal sign. The latter restriction is necessary because it would be impossible - to determine the parameter type. In general, parameters are legal only in Data - Manipulation Languange (DML) statements, and not in Data Defination Language - (DDL) statements. - </para> - </note> <para> The parameter markers must be bound to application variables using - <function>mysqli_stmt_bind_param</function> and/or <function>mysqli_stmt_bind_result</function> - before executing the statement or fetching rows. + <function>mysqli_stmt_bind_param</function> and/or + <function>mysqli_stmt_bind_result</function> before executing the + statement or fetching rows. </para> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success; + <variablelist> + &mysqli.stmt.description; + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + The query, as a string. It must consist of a single SQL statement. + </para> + <para> + You can include one or more parameter markers in the SQL statement by + embedding question mark (<literal>?</literal>) characters at the + appropriate positions. + </para> + <note> + <para> + You should not add a terminating semicolon or <literal>\g</literal> + to the statement. + </para> + </note> + <note> + <para> + The markers are legal only in certain places in SQL statements. + For example, they are allowed in the VALUES() list of an INSERT statement + (to specify column values for a row), or in a comparison with a column in + a WHERE clause to specify a comparison value. + </para> + <para> + However, they are not allowed for identifiers (such as table or column names), + in the select list that names the columns to be returned by a SELECT statement), + or to specify both operands of a binary operator such as the <literal>=</literal> + equal sign. The latter restriction is necessary because it would be impossible + to determine the parameter type. In general, parameters are legal only in Data + Manipulation Languange (DML) statements, and not in Data Defination Language + (DDL) statements. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_stmt_init</function>, - <function>mysqli_stmt_execute</function>, - <function>mysqli_stmt_fetch</function>, - <function>mysqli_stmt_bind_param</function>, - <function>mysqli_stmt_bind_result</function>&listendand; - <function>mysqli_stmt_close</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -174,6 +181,19 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <function>mysqli_stmt_init</function>, + <function>mysqli_stmt_execute</function>, + <function>mysqli_stmt_fetch</function>, + <function>mysqli_stmt_bind_param</function>, + <function>mysqli_stmt_bind_result</function> + <function>mysqli_stmt_close</function>. + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-reset"> <refnamediv> <refname>mysqli_stmt_reset</refname> - <refname>stmt->reset</refname> + <refname>stmt->reset()</refname> <refpurpose>Resets a prepared statement</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_stmt_reset</methodname> @@ -22,26 +23,43 @@ </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 + Resets a prepared statement on client and server to state after prepare. + </para> + <para> + For now this is mainly used to reset data sent with <function>mysqli_stmt_send_long_data</function>. </para> - <note> - <para> - To prepare a statement with another query use function <function>mysqli_stmt_prepare</function>. - </para> - </note> + <para> + To prepare a statement with another query use function + <function>mysqli_stmt_prepare</function>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.stmt.description; + </variablelist> + </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para>&return.success;</para> + <para> + &return.success; + </para> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_prepare</function>. + <simplelist> + <member><function>mysqli_prepare</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-result-metadata"> <refnamediv> <refname>mysqli_stmt_result_metadata</refname> + <refname>stmt->result_metadata()</refname> <refpurpose>Returns result set metadata from a prepared statement</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>mysqli_result</type><methodname>mysqli_stmt_result_metadata</methodname> @@ -53,21 +55,24 @@ </para> </note> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>mysqli_stmt_result_metadata</function> returns a result object or &false; if - an error occured. + <variablelist> + &mysqli.stmt.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_prepare</function>&listendand; - <function>mysqli_free_result</function>. + Returns a result object or &false; if an error occured. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <para> <example> @@ -136,6 +141,17 @@ </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_prepare</function></member> + <member><function>mysqli_free_result</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-send-long-data"> <refnamediv> <refname>mysqli_stmt_send_long_data</refname> - <refname>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> + + <refsect1 role="description"> + &reftitle.description; + <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>mysqli_stmt_send_long_data</methodname> - <methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam> + <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> - <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> + </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> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.stmt.description; + <varlistentry> + <term><parameter>param_nr</parameter></term> + <listitem> + <para> + Indicates which parameter to associate the data with. Parameters are + numbered beginning with 0. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <para> + A string containing data to be sent. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para>&return.success;</para> + <para> + &return.success; + </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -61,13 +87,17 @@ </programlisting> </example> </refsect1> - <refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>mysqli_prepare</function>&listendand; - <function>mysqli_stmt_bind_param</function>. + <simplelist> + <member><function>mysqli_prepare</function></member> + <member><function>mysqli_stmt_bind_param</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-sqlstate"> <refnamediv> <refname>mysqli_stmt_sqlstate</refname> <refpurpose>Returns SQLSTATE error from previous statement operation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>mysqli_stmt_sqlstate</methodname> <methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam> @@ -18,28 +19,36 @@ The values are specified by ANSI SQL and ODBC. For a list of possible values, see <ulink url="&url.mysql.docs.error;">&url.mysql.docs.error;</ulink>. </para> - <note> - <para> - Note that not all MySQL errors are yet mapped to SQLSTATE's. - The value <literal>HY000</literal> (general error) is used for unmapped errors. - </para> - </note> </refsect1> - <refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.stmt.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns a string containing the SQLSTATE error code for the last error. The error code consists of five characters. <literal>'00000'</literal> means no error. </para> </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_stmt_errno</function>&listendand; - <function>mysqli_stmt_error</function>. - </para> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + Note that not all MySQL errors are yet mapped to SQLSTATE's. + The value <literal>HY000</literal> (general error) is used for unmapped errors. + </para> + </note> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -126,6 +135,17 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_stmt_errno</function></member> + <member><function>mysqli_stmt_error</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-stmt-store-result"> <refnamediv> <refname>mysqli_stmt_store_result</refname> - <refname>mysqli_stmt->store_result</refname> + <refname>mysqli_stmt->store_result()</refname> <refpurpose>Transfers a result set from a prepared statement</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_stmt_store_result</methodname> @@ -36,19 +37,24 @@ </para> </note> </refsect1> - <refsect1> - &reftitle.returnvalues; - <para>&return.success;</para> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.stmt.description; + </variablelist> + </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_prepare</function>, - <function>mysqli_stmt_result_metadata</function>&listendand; - <function>mysqli_stmt_fetch</function>. + &return.success; </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -133,6 +139,18 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_prepare</function></member> + <member><function>mysqli_stmt_result_metadata</function></member> + <member><function>mysqli_stmt_fetch</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-store-result"> <refnamediv> <refname>mysqli_store_result</refname> - <refname>mysqli->store_result</refname> + <refname>mysqli->store_result()</refname> <refpurpose>Transfers a result set from the last query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>mysqli_result</type><methodname>mysqli_store_result</methodname> @@ -26,14 +27,22 @@ represented by the <parameter>link</parameter> parameter to be used with the <function>mysqli_data_seek</function> function. </para> - <note> - <para> - Although it is always good practice to free the memory used by the result of - a query using the <function>mysqli_free_result</function> function, when - transfering large result sets using the <function>mysqli_store_result</function> - this becomes particularly important. - </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &mysqli.link.description; + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a buffered result object or &false; if an error occurred. + </para> <note> <para> <function>mysqli_store_result</function> returns &false; in case the query @@ -51,25 +60,37 @@ </para> </note> </refsect1> - <refsect1> - &reftitle.returnvalues; - <para> - Returns a buffered result object or &false; if an error occurred. - </para> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + Although it is always good practice to free the memory used by the result + of a query using the <function>mysqli_free_result</function> function, + when transfering large result sets using the + <function>mysqli_store_result</function> this becomes particularly + important. + </para> + </note> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="examples"> + &reftitle.examples; <para> - <function>mysqli_real_query</function>&listendand; - <function>mysqli_use_result</function>. + See <function>mysqli_multi_query</function>. </para> </refsect1> - <refsect1> - &reftitle.examples; + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See <function>mysqli_multi_query</function>. + <simplelist> + <member><function>mysqli_real_query</function></member> + <member><function>mysqli_use_result</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-thread-id"> <refnamediv> <refname>mysqli_thread_id</refname> <refname>mysqli->thread_id</refname> <refpurpose>Returns the thread ID for the current connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>int</type><methodname>mysqli_thread_id</methodname> @@ -32,23 +33,29 @@ will be assigned. </para> <para> - To kill a running query you can use the SQL command <literal>KILL QUERY processid</literal>. + To kill a running query you can use the SQL command + <literal>KILL QUERY processid</literal>. </para> </note> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>mysqli_thread_id</function> returns the Thread ID for the current connection. + <variablelist> + &mysqli.link.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_kill</function>. + Returns the Thread ID for the current connection. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -119,6 +126,16 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_kill</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-thread-safe"> <refnamediv> <refname>mysqli_thread_safe</refname> <refpurpose>Returns whether thread safety is given or not</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>bool</type><methodname>mysqli_thread_safe</methodname> <void /> </methodsynopsis> <para> - <function>mysqli_thread_safe</function> indicates whether the - client library is compiled as thread-safe. + Tells whether the client library is compiled as thread-safe. </para> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &true; if the client library is thread-safe, otherwise &false;. </para> </refsect1> + </refentry>  + <refentry id="function.mysqli-use-result"> <refnamediv> <refname>mysqli_use_result</refname> - <refname>mysqli->use_result</refname> + <refname>mysqli->use_result()</refname> <refpurpose>Initiate a result set retrieval</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>mysqli_result</type><methodname>mysqli_use_result</methodname> @@ -22,13 +23,15 @@ </methodsynopsis> </classsynopsis> <para> - <function>mysqli_use_result</function> is used to initiate the retrieval - of a result set from the last query executed using the - <function>mysqli_real_query</function> function on the database connection - specified by the <parameter>link</parameter> parameter. Either this or the - <function>mysqli_store_result</function> function must be called before the - results of a query can be retrieved, and one or the other must be called - to prevent the next query on that database connection from failing. + Used to initiate the retrieval of a result set from the last query + executed using the <function>mysqli_real_query</function> function on the + database connection. + </para> + <para> + Either this or the <function>mysqli_store_result</function> function must + be called before the results of a query can be retrieved, and one or the + other must be called to prevent the next query on that database connection + from failing. </para> <note> <para> @@ -44,20 +47,15 @@ </para> </note> </refsect1> - <refsect1> + + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns an unbuffered result object or &false; if an error occurred. </para> </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>mysqli_real_query</function>&listendand; - <function>mysqli_store_result</function>. - </para> - </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -150,6 +148,17 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_real_query</function></member> + <member><function>mysqli_store_result</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.mysqli-warning-count"> <refnamediv> <refname>mysqli_warning_count</refname> <refname>mysqli->warning_count</refname> <refpurpose>Returns the number of warnings from the last query for the given link</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <para>Procedural style:</para> <methodsynopsis> <type>int</type><methodname>mysqli_warning_count</methodname> @@ -19,9 +20,7 @@ <fieldsynopsis><type>int</type><varname>warning_count</varname></fieldsynopsis> </classsynopsis> <para> - <function>mysqli_warning_count</function> returns the number of warnings - from the last query in the connection represented by the - <parameter>link</parameter> parameter. + Returns the number of warnings from the last query in the connection. </para> <note> <para> @@ -30,21 +29,24 @@ </para> </note> </refsect1> - <refsect1> - &reftitle.returnvalues; + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Number of warnings or zero if there are no warnings. + <variablelist> + &mysqli.link.description; + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>mysqli_errno</function>, - <function>mysqli_error</function>&listendand; - <function>mysqli_sqlstate</function>. + Number of warnings or zero if there are no warnings. </para> </refsect1> - <refsect1> + + <refsect1 role="examples"> &reftitle.examples; <example> <title>Object oriented style</title> @@ -123,6 +125,18 @@ ]]> </screen> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mysqli_errno</function></member> + <member><function>mysqli_error</function></member> + <member><function>mysqli_sqlstate</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file