added examples, see also and corrected typos

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@128719 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2003-05-25 18:02:46 +00:00
parent 86ad6d1991
commit 0c4a2e7313
32 changed files with 242 additions and 108 deletions

View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.mysqli-affected-rows">
<refnamediv>
<refname>mysqli_affected_rows</refname>
<refpurpose>Get the number of affected rows in a previous MySQL operation</refpurpose>
<refpurpose>Gets the number of affected rows in a previous MySQL operation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.mysqli-autocommit">
<refnamediv>
<refname>mysqli_autocommit</refname>
@ -20,6 +20,25 @@
<para>
&return.success;
</para>
<para>
<example>
<title>Using the mysqli_autocommit function</title>
<programlisting role="php">
<![CDATA[
<?php
/* Open a connection */
$link = mysqli_connect("localhost", "user", "pass");
mysqli_select_db("mydb");
/* Turn on autocommit */
mysqli_autocommit($link, true);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-change-user">
<refnamediv>
<refname>mysqli_change_user</refname>
@ -16,7 +16,7 @@
</methodsynopsis>
<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 sets the
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>
@ -41,6 +41,25 @@
closing all temporary tables, and unlocking all locked tables.
</para>
</note>
<para>
<example>
<title>Using the mysqli_change_user function</title>
<programlisting role="php">
<![CDATA[
<?php
/* Open a connection as foo@localhost and select foo_db */
$link = mysqli_connect("localhost", "foo", "pass");
mysqli_select_db("foo_db");
/* Change user to bar@localhost and default database to bar_db */
mysqli_change_user($link, "bar", "otherpass", "bar_db");
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-character-set-name">
<refnamediv>
<refname>mysqli_character_set_name</refname>
@ -14,6 +14,28 @@
<para>
Returns the current character set for the database connection specified by the
<parameter>link</parameter> parameter.
</para>
<para>
<example>
<title>Using the mysqli_character_set_name function</title>
<programlisting role="php">
<![CDATA[
<?php
/* Open a connection */
$link = mysqli_connect("localhost", "username", "password");
/* Print current character set */
$charset = mysqli_character_set_name($link);
printf ("Current character set is %s\n",$charset);
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>mysqli_real_escape_string</function>.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-connect">
<refnamediv>
<refname>mysqli_connect</refname>
@ -48,6 +48,21 @@
MySQL database is determined by the <parameter>host</parameter> parameter.
</para>
</note>
<para>
<example>
<title>Using the mysqli_connect function</title>
<programlisting role="php">
<![CDATA[
<?php
/* Open a connection as foo@localhost and make bar the default database */
$link = mysqli_connect("localhost", "foo", "password", "bar");
?>
]]>
</programlisting>
</example>
</para>
<para>
See also
<function>mysqli_close</function> and

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-data-seek">
<refnamediv>
<refname>mysqli_data_seek</refname>
@ -24,9 +24,43 @@
<function>mysqli_store_result</function> function.
</para>
</note>
<para>
<example>
<title>Using the mysqli_data_seek function</title>
<programlisting role="php">
<![CDATA[
<?php
/* Open a connection */
$link = mysqli_connect("localhost", "username", "password");
mysqli_select_db("mydb");
/* Get some rows and store them */
$query = "SELECT DINSTINCT name FROM employee ORDER BY name";
$result = mysqli_query($query) or die(mysqli_error()):
$rows = mysqli_store_result($result);
$total = mysqli_num_fields($rows);
if ($total > 0) { // there is at least one row
/* Get the last employee */
mysqli_data_seek($rows, mysqli_num_rows($result) -1);
$employee = mysqli_fetch_row($rows);
printf ("Employee name : %s\n", $employee[0]);
}
mysqli_free_result($rows);
?>
]]>
</programlisting>
</example>
</para>
<para>
See also
<function>mysqli_store_result</function> and
<function>mysqli_store_result</function>,
<function>mysqli_fetch_row</function> and
<function>mysqli_num_rows</function>.
</para>
</refsect1>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-disable-reads-from-master">
<refnamediv>
<refname>mysqli_disable_reads_from_master</refname>
@ -11,9 +11,9 @@
<type>void</type><methodname>mysqli_disable_reads_from_master</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-disable-rpl-parse">
<refnamediv>
<refname>mysqli_disable_rpl_parse</refname>
@ -11,9 +11,9 @@
<type>void</type><methodname>mysqli_disable_rpl_parse</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-dump-debug-info">
<refnamediv>
<refname>mysqli_dump_debug_info</refname>
@ -12,11 +12,12 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
This function is designed to be executed by a user with the SUPER privledge and
This function is designed to be executed by an user with the SUPER privlege 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. When
executed <function>mysqli_dump_debug_info</function> will return a boolean
indicating the success or failure of the dump.
to the connection specified by the <parameter>link</parameter> parameter.
</para>
<para>
&return.success;
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-enable-reads-from-master">
<refnamediv>
<refname>mysqli_enable_reads_from_master</refname>
@ -11,9 +11,9 @@
<type>void</type><methodname>mysqli_enable_reads_from_master</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-enable-rpl-parse">
<refnamediv>
<refname>mysqli_enable_rpl_parse</refname>
@ -11,9 +11,9 @@
<type>void</type><methodname>mysqli_enable_rpl_parse</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-error">
<refnamediv>
<refname>mysqli_error</refname>
@ -19,6 +19,23 @@
represented by the <parameter>link</parameter> parameter. If no error has occured,
this function will return an empty string.
</para>
<para>
<example>
<title>Using the mysqli_error function</title>
<programlisting role="php">
<![CDATA[
<?php
/* Fail to open a connection */
$host = "no_such_host";
$link = mysqli_connect($host, "username", "password") or
die("Couldn't connect : " . mysqli_error());
?>
]]>
</programlisting>
</example>
</para>
<para>
See also
<function>mysqli_errno</function>.

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.mysqli-execute">
<refnamediv>
<refname>mysqli_execute</refname>
@ -68,6 +68,10 @@
</programlisting>
</example>
</para>
<para>
See also <function>mysqli_prepare</function> and
<function>mysqli_bind_param</function>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-options">
<refnamediv>
<refname>mysqli_options</refname>
@ -13,9 +13,9 @@
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
<methodparam><type>mixed</type><parameter>values</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-param-count">
<refnamediv>
<refname>mysqli_param_count</refname>
@ -11,9 +11,9 @@
<type>int</type><methodname>mysqli_param_count</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-prepare-result">
<refnamediv>
<refname>mysqli_prepare_result</refname>
@ -11,9 +11,9 @@
<type>resource</type><methodname>mysqli_prepare_result</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-profiler">
<refnamediv>
<refname>mysqli_profiler</refname>
@ -13,9 +13,9 @@
<methodparam><type>string</type><parameter>info</parameter></methodparam>
<methodparam><type>int</type><parameter>port</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-read-query-result">
<refnamediv>
<refname>mysqli_read_query_result</refname>
@ -11,9 +11,9 @@
<type>bool</type><methodname>mysqli_read_query_result</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-real-connect">
<refnamediv>
<refname>mysqli_real_connect</refname>
<refpurpose>open a connection to a mysql server</refpurpose>
<refpurpose>Opens a connection to a mysql server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -17,9 +17,9 @@
<methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
<para>
See also
<function>mysqli_connect</function> and

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.mysqli-real-escape-string">
<refnamediv>
<refname>mysqli_real_escape_string</refname>
@ -16,8 +16,11 @@
<methodparam><type>string</type><parameter>escapestr</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
<para>
See also <function>mysqli_character_set_name</function>.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-reload">
<refnamediv>
<refname>mysqli_reload</refname>
@ -11,9 +11,9 @@
<type>bool</type><methodname>mysqli_reload</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-rollback">
<refnamediv>
<refname>mysqli_rollback</refname>
@ -11,9 +11,9 @@
<type>bool</type><methodname>mysqli_rollback</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-rpl-parse-enabled">
<refnamediv>
<refname>mysqli_rpl_parse_enabled</refname>
@ -11,9 +11,9 @@
<type>int</type><methodname>mysqli_rpl_parse_enabled</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-rpl-probe">
<refnamediv>
<refname>mysqli_rpl_probe</refname>
@ -11,9 +11,9 @@
<type>bool</type><methodname>mysqli_rpl_probe</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-rpl-query-type">
<refnamediv>
<refname>mysqli_rpl_query_type</refname>
@ -11,9 +11,9 @@
<type>int</type><methodname>mysqli_rpl_query_type</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-send-long-data">
<refnamediv>
<refname>mysqli_send_long_data</refname>
@ -13,9 +13,9 @@
<methodparam><type>int</type><parameter>param_nr</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-send-query">
<refnamediv>
<refname>mysqli_send_query</refname>
@ -12,9 +12,9 @@
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-ssl-set">
<refnamediv>
<refname>mysqli_ssl_set</refname>
@ -16,9 +16,9 @@
<methodparam choice='opt'><type>string</type><parameter>capath</parameter></methodparam>
<methodparam choice='opt'><type>string</type><parameter>cipher</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-stmt-affected-rows">
<refnamediv>
<refname>mysqli_stmt_affected_rows</refname>
@ -11,9 +11,9 @@
<type>mixed</type><methodname>mysqli_stmt_affected_rows</methodname>
<methodparam><type>object</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-stmt-close">
<refnamediv>
<refname>mysqli_stmt_close</refname>
@ -11,9 +11,9 @@
<type>bool</type><methodname>mysqli_stmt_close</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-stmt-errno">
<refnamediv>
<refname>mysqli_stmt_errno</refname>
@ -11,9 +11,9 @@
<type>int</type><methodname>mysqli_stmt_errno</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.mysqli-stmt-error">
<refnamediv>
<refname>mysqli_stmt_error</refname>
@ -11,9 +11,9 @@
<type>string</type><methodname>mysqli_stmt_error</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
&warn.undocumented.func;
</refsect1>
</refentry>