From 0c4a2e7313431162957d9766c1233ecca3aa5351 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sun, 25 May 2003 18:02:46 +0000 Subject: [PATCH] added examples, see also and corrected typos git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@128719 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../mysqli/functions/mysqli-affected-rows.xml | 4 +- .../mysqli/functions/mysqli-autocommit.xml | 21 +++++++++- .../mysqli/functions/mysqli-change-user.xml | 23 ++++++++++- .../functions/mysqli-character-set-name.xml | 24 +++++++++++- reference/mysqli/functions/mysqli-connect.xml | 17 ++++++++- .../mysqli/functions/mysqli-data-seek.xml | 38 ++++++++++++++++++- .../mysqli-disable-reads-from-master.xml | 8 ++-- .../functions/mysqli-disable-rpl-parse.xml | 8 ++-- .../functions/mysqli-dump-debug-info.xml | 11 +++--- .../mysqli-enable-reads-from-master.xml | 8 ++-- .../functions/mysqli-enable-rpl-parse.xml | 8 ++-- reference/mysqli/functions/mysqli-error.xml | 19 +++++++++- reference/mysqli/functions/mysqli-execute.xml | 6 ++- reference/mysqli/functions/mysqli-options.xml | 8 ++-- .../mysqli/functions/mysqli-param-count.xml | 8 ++-- .../functions/mysqli-prepare-result.xml | 8 ++-- .../mysqli/functions/mysqli-profiler.xml | 8 ++-- .../functions/mysqli-read-query-result.xml | 8 ++-- .../mysqli/functions/mysqli-real-connect.xml | 10 ++--- .../functions/mysqli-real-escape-string.xml | 9 +++-- reference/mysqli/functions/mysqli-reload.xml | 8 ++-- .../mysqli/functions/mysqli-rollback.xml | 8 ++-- .../functions/mysqli-rpl-parse-enabled.xml | 8 ++-- .../mysqli/functions/mysqli-rpl-probe.xml | 8 ++-- .../functions/mysqli-rpl-query-type.xml | 8 ++-- .../functions/mysqli-send-long-data.xml | 8 ++-- .../mysqli/functions/mysqli-send-query.xml | 8 ++-- reference/mysqli/functions/mysqli-ssl-set.xml | 8 ++-- .../functions/mysqli-stmt-affected-rows.xml | 8 ++-- .../mysqli/functions/mysqli-stmt-close.xml | 8 ++-- .../mysqli/functions/mysqli-stmt-errno.xml | 8 ++-- .../mysqli/functions/mysqli-stmt-error.xml | 8 ++-- 32 files changed, 242 insertions(+), 108 deletions(-) diff --git a/reference/mysqli/functions/mysqli-affected-rows.xml b/reference/mysqli/functions/mysqli-affected-rows.xml index 57f4814261..59861f895c 100644 --- a/reference/mysqli/functions/mysqli-affected-rows.xml +++ b/reference/mysqli/functions/mysqli-affected-rows.xml @@ -1,9 +1,9 @@ - + mysqli_affected_rows - Get the number of affected rows in a previous MySQL operation + Gets the number of affected rows in a previous MySQL operation Description diff --git a/reference/mysqli/functions/mysqli-autocommit.xml b/reference/mysqli/functions/mysqli-autocommit.xml index f7dd1c1da2..b2dd4c9fe9 100644 --- a/reference/mysqli/functions/mysqli-autocommit.xml +++ b/reference/mysqli/functions/mysqli-autocommit.xml @@ -1,5 +1,5 @@ - + mysqli_autocommit @@ -20,6 +20,25 @@ &return.success; + + + Using the mysqli_autocommit function + + +]]> + + + diff --git a/reference/mysqli/functions/mysqli-change-user.xml b/reference/mysqli/functions/mysqli-change-user.xml index d7a5f9fdd2..64bccc78a1 100644 --- a/reference/mysqli/functions/mysqli-change-user.xml +++ b/reference/mysqli/functions/mysqli-change-user.xml @@ -1,5 +1,5 @@ - + mysqli_change_user @@ -16,7 +16,7 @@ mysqli_change_user is used to change the user of the specified - database connection as given by the link parameter and sets the + database connection as given by the link parameter and to set the current database to that specified by the database parameter. @@ -41,6 +41,25 @@ closing all temporary tables, and unlocking all locked tables. + + + Using the mysqli_change_user function + + +]]> + + + diff --git a/reference/mysqli/functions/mysqli-character-set-name.xml b/reference/mysqli/functions/mysqli-character-set-name.xml index 4c467eda7b..d8699978c7 100644 --- a/reference/mysqli/functions/mysqli-character-set-name.xml +++ b/reference/mysqli/functions/mysqli-character-set-name.xml @@ -1,5 +1,5 @@ - + mysqli_character_set_name @@ -14,6 +14,28 @@ Returns the current character set for the database connection specified by the link parameter. + + + + Using the mysqli_character_set_name function + + +]]> + + + + + See also mysqli_real_escape_string. diff --git a/reference/mysqli/functions/mysqli-connect.xml b/reference/mysqli/functions/mysqli-connect.xml index e1b07fe367..fc165155e5 100644 --- a/reference/mysqli/functions/mysqli-connect.xml +++ b/reference/mysqli/functions/mysqli-connect.xml @@ -1,5 +1,5 @@ - + mysqli_connect @@ -48,6 +48,21 @@ MySQL database is determined by the host parameter. + + + Using the mysqli_connect function + + +]]> + + + See also mysqli_close and diff --git a/reference/mysqli/functions/mysqli-data-seek.xml b/reference/mysqli/functions/mysqli-data-seek.xml index 492348833e..ec4f6b00c2 100644 --- a/reference/mysqli/functions/mysqli-data-seek.xml +++ b/reference/mysqli/functions/mysqli-data-seek.xml @@ -1,5 +1,5 @@ - + mysqli_data_seek @@ -24,9 +24,43 @@ mysqli_store_result function. + + + Using the mysqli_data_seek function + + 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); + +?> +]]> + + + See also - mysqli_store_result and + mysqli_store_result, + mysqli_fetch_row and mysqli_num_rows. diff --git a/reference/mysqli/functions/mysqli-disable-reads-from-master.xml b/reference/mysqli/functions/mysqli-disable-reads-from-master.xml index 784ea5b624..0137a8b5d6 100644 --- a/reference/mysqli/functions/mysqli-disable-reads-from-master.xml +++ b/reference/mysqli/functions/mysqli-disable-reads-from-master.xml @@ -1,5 +1,5 @@ - + mysqli_disable_reads_from_master @@ -11,9 +11,9 @@ voidmysqli_disable_reads_from_master resourcelink - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-disable-rpl-parse.xml b/reference/mysqli/functions/mysqli-disable-rpl-parse.xml index e3d7e2ae12..b1c962f548 100644 --- a/reference/mysqli/functions/mysqli-disable-rpl-parse.xml +++ b/reference/mysqli/functions/mysqli-disable-rpl-parse.xml @@ -1,5 +1,5 @@ - + mysqli_disable_rpl_parse @@ -11,9 +11,9 @@ voidmysqli_disable_rpl_parse resourcelink - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-dump-debug-info.xml b/reference/mysqli/functions/mysqli-dump-debug-info.xml index 0382765b36..3ee1418083 100644 --- a/reference/mysqli/functions/mysqli-dump-debug-info.xml +++ b/reference/mysqli/functions/mysqli-dump-debug-info.xml @@ -1,5 +1,5 @@ - + mysqli_dump_debug_info @@ -12,11 +12,12 @@ resourcelink - 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 link parameter. When - executed mysqli_dump_debug_info will return a boolean - indicating the success or failure of the dump. + to the connection specified by the link parameter. + + + &return.success; diff --git a/reference/mysqli/functions/mysqli-enable-reads-from-master.xml b/reference/mysqli/functions/mysqli-enable-reads-from-master.xml index 4feaf72139..ee980d5350 100644 --- a/reference/mysqli/functions/mysqli-enable-reads-from-master.xml +++ b/reference/mysqli/functions/mysqli-enable-reads-from-master.xml @@ -1,5 +1,5 @@ - + mysqli_enable_reads_from_master @@ -11,9 +11,9 @@ voidmysqli_enable_reads_from_master resourcelink - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-enable-rpl-parse.xml b/reference/mysqli/functions/mysqli-enable-rpl-parse.xml index e54c95a194..2edf303695 100644 --- a/reference/mysqli/functions/mysqli-enable-rpl-parse.xml +++ b/reference/mysqli/functions/mysqli-enable-rpl-parse.xml @@ -1,5 +1,5 @@ - + mysqli_enable_rpl_parse @@ -11,9 +11,9 @@ voidmysqli_enable_rpl_parse resourcelink - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-error.xml b/reference/mysqli/functions/mysqli-error.xml index 426613fd8f..517568dc1d 100644 --- a/reference/mysqli/functions/mysqli-error.xml +++ b/reference/mysqli/functions/mysqli-error.xml @@ -1,5 +1,5 @@ - + mysqli_error @@ -19,6 +19,23 @@ represented by the link parameter. If no error has occured, this function will return an empty string. + + + Using the mysqli_error function + + +]]> + + + See also mysqli_errno. diff --git a/reference/mysqli/functions/mysqli-execute.xml b/reference/mysqli/functions/mysqli-execute.xml index 4d69d60d24..fc9beffb8e 100644 --- a/reference/mysqli/functions/mysqli-execute.xml +++ b/reference/mysqli/functions/mysqli-execute.xml @@ -1,5 +1,5 @@ - + mysqli_execute @@ -68,6 +68,10 @@ + + See also mysqli_prepare and + mysqli_bind_param + diff --git a/reference/mysqli/functions/mysqli-options.xml b/reference/mysqli/functions/mysqli-options.xml index 2e2454f2f4..8c80f9055d 100644 --- a/reference/mysqli/functions/mysqli-options.xml +++ b/reference/mysqli/functions/mysqli-options.xml @@ -1,5 +1,5 @@ - + mysqli_options @@ -13,9 +13,9 @@ intflags mixedvalues - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-param-count.xml b/reference/mysqli/functions/mysqli-param-count.xml index e1932a40cf..01db8dfb0e 100644 --- a/reference/mysqli/functions/mysqli-param-count.xml +++ b/reference/mysqli/functions/mysqli-param-count.xml @@ -1,5 +1,5 @@ - + mysqli_param_count @@ -11,9 +11,9 @@ intmysqli_param_count resourcestmt - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-prepare-result.xml b/reference/mysqli/functions/mysqli-prepare-result.xml index 10e9a09340..f249f82749 100644 --- a/reference/mysqli/functions/mysqli-prepare-result.xml +++ b/reference/mysqli/functions/mysqli-prepare-result.xml @@ -1,5 +1,5 @@ - + mysqli_prepare_result @@ -11,9 +11,9 @@ resourcemysqli_prepare_result resourcestmt - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-profiler.xml b/reference/mysqli/functions/mysqli-profiler.xml index 99dfb5de79..d1bb8143b6 100644 --- a/reference/mysqli/functions/mysqli-profiler.xml +++ b/reference/mysqli/functions/mysqli-profiler.xml @@ -1,5 +1,5 @@ - + mysqli_profiler @@ -13,9 +13,9 @@ stringinfo intport - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-read-query-result.xml b/reference/mysqli/functions/mysqli-read-query-result.xml index ce9b6bafbc..ec6204f1f1 100644 --- a/reference/mysqli/functions/mysqli-read-query-result.xml +++ b/reference/mysqli/functions/mysqli-read-query-result.xml @@ -1,5 +1,5 @@ - + mysqli_read_query_result @@ -11,9 +11,9 @@ boolmysqli_read_query_result resourcelink - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-real-connect.xml b/reference/mysqli/functions/mysqli-real-connect.xml index b74196d763..34ec6a49fe 100644 --- a/reference/mysqli/functions/mysqli-real-connect.xml +++ b/reference/mysqli/functions/mysqli-real-connect.xml @@ -1,9 +1,9 @@ - + mysqli_real_connect - open a connection to a mysql server + Opens a connection to a mysql server Description @@ -17,9 +17,9 @@ intport stringsocket - -&warn.undocumented.func; - + + &warn.undocumented.func; + See also mysqli_connect and diff --git a/reference/mysqli/functions/mysqli-real-escape-string.xml b/reference/mysqli/functions/mysqli-real-escape-string.xml index 428c9703da..0cce3faf9c 100644 --- a/reference/mysqli/functions/mysqli-real-escape-string.xml +++ b/reference/mysqli/functions/mysqli-real-escape-string.xml @@ -1,5 +1,5 @@ - + mysqli_real_escape_string @@ -16,8 +16,11 @@ stringescapestr - &warn.undocumented.func; - + &warn.undocumented.func; + + + See also mysqli_character_set_name. + diff --git a/reference/mysqli/functions/mysqli-reload.xml b/reference/mysqli/functions/mysqli-reload.xml index ce099cc5cb..058a40e4b1 100644 --- a/reference/mysqli/functions/mysqli-reload.xml +++ b/reference/mysqli/functions/mysqli-reload.xml @@ -1,5 +1,5 @@ - + mysqli_reload @@ -11,9 +11,9 @@ boolmysqli_reload resourcelink - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-rollback.xml b/reference/mysqli/functions/mysqli-rollback.xml index 38c4237a90..e9b698b0fa 100644 --- a/reference/mysqli/functions/mysqli-rollback.xml +++ b/reference/mysqli/functions/mysqli-rollback.xml @@ -1,5 +1,5 @@ - + mysqli_rollback @@ -11,9 +11,9 @@ boolmysqli_rollback resourcelink - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-rpl-parse-enabled.xml b/reference/mysqli/functions/mysqli-rpl-parse-enabled.xml index 0a8f32e6ee..876683097d 100644 --- a/reference/mysqli/functions/mysqli-rpl-parse-enabled.xml +++ b/reference/mysqli/functions/mysqli-rpl-parse-enabled.xml @@ -1,5 +1,5 @@ - + mysqli_rpl_parse_enabled @@ -11,9 +11,9 @@ intmysqli_rpl_parse_enabled resourcelink - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-rpl-probe.xml b/reference/mysqli/functions/mysqli-rpl-probe.xml index 24a8bb9560..25f4f90e00 100644 --- a/reference/mysqli/functions/mysqli-rpl-probe.xml +++ b/reference/mysqli/functions/mysqli-rpl-probe.xml @@ -1,5 +1,5 @@ - + mysqli_rpl_probe @@ -11,9 +11,9 @@ boolmysqli_rpl_probe resourcelink - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-rpl-query-type.xml b/reference/mysqli/functions/mysqli-rpl-query-type.xml index f869b7fc02..2a045168fe 100644 --- a/reference/mysqli/functions/mysqli-rpl-query-type.xml +++ b/reference/mysqli/functions/mysqli-rpl-query-type.xml @@ -1,5 +1,5 @@ - + mysqli_rpl_query_type @@ -11,9 +11,9 @@ intmysqli_rpl_query_type stringquery - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-send-long-data.xml b/reference/mysqli/functions/mysqli-send-long-data.xml index d8b9ec3214..89f7388ee3 100644 --- a/reference/mysqli/functions/mysqli-send-long-data.xml +++ b/reference/mysqli/functions/mysqli-send-long-data.xml @@ -1,5 +1,5 @@ - + mysqli_send_long_data @@ -13,9 +13,9 @@ intparam_nr stringdata - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-send-query.xml b/reference/mysqli/functions/mysqli-send-query.xml index 634f339cc0..15858f6134 100644 --- a/reference/mysqli/functions/mysqli-send-query.xml +++ b/reference/mysqli/functions/mysqli-send-query.xml @@ -1,5 +1,5 @@ - + mysqli_send_query @@ -12,9 +12,9 @@ resourcelink stringquery - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-ssl-set.xml b/reference/mysqli/functions/mysqli-ssl-set.xml index 5b80cdbb40..eec2228c7a 100644 --- a/reference/mysqli/functions/mysqli-ssl-set.xml +++ b/reference/mysqli/functions/mysqli-ssl-set.xml @@ -1,5 +1,5 @@ - + mysqli_ssl_set @@ -16,9 +16,9 @@ stringcapath stringcipher - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-stmt-affected-rows.xml b/reference/mysqli/functions/mysqli-stmt-affected-rows.xml index d4dc492393..27bd767303 100644 --- a/reference/mysqli/functions/mysqli-stmt-affected-rows.xml +++ b/reference/mysqli/functions/mysqli-stmt-affected-rows.xml @@ -1,5 +1,5 @@ - + mysqli_stmt_affected_rows @@ -11,9 +11,9 @@ mixedmysqli_stmt_affected_rows objectstmt - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-stmt-close.xml b/reference/mysqli/functions/mysqli-stmt-close.xml index 4d2b4b9c10..06cc1f5bb1 100644 --- a/reference/mysqli/functions/mysqli-stmt-close.xml +++ b/reference/mysqli/functions/mysqli-stmt-close.xml @@ -1,5 +1,5 @@ - + mysqli_stmt_close @@ -11,9 +11,9 @@ boolmysqli_stmt_close resourcestmt - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-stmt-errno.xml b/reference/mysqli/functions/mysqli-stmt-errno.xml index fe1b5c8bca..ce1ff265b4 100644 --- a/reference/mysqli/functions/mysqli-stmt-errno.xml +++ b/reference/mysqli/functions/mysqli-stmt-errno.xml @@ -1,5 +1,5 @@ - + mysqli_stmt_errno @@ -11,9 +11,9 @@ intmysqli_stmt_errno resourcestmt - -&warn.undocumented.func; - + + &warn.undocumented.func; + diff --git a/reference/mysqli/functions/mysqli-stmt-error.xml b/reference/mysqli/functions/mysqli-stmt-error.xml index 760272c82d..a761addc40 100644 --- a/reference/mysqli/functions/mysqli-stmt-error.xml +++ b/reference/mysqli/functions/mysqli-stmt-error.xml @@ -1,5 +1,5 @@ - + mysqli_stmt_error @@ -11,9 +11,9 @@ stringmysqli_stmt_error resourcestmt - -&warn.undocumented.func; - + + &warn.undocumented.func; +