From 8a794b443607b03a85b9a8c491dc1330ba9c2a68 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Tue, 12 Aug 2003 09:54:55 +0000 Subject: [PATCH] updating protos adding some tags less redundancy git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@137471 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/ovrimos/functions/ovrimos-close.xml | 8 ++------ .../ovrimos/functions/ovrimos-commit.xml | 9 +++------ .../ovrimos/functions/ovrimos-connect.xml | 11 +++++----- .../ovrimos/functions/ovrimos-cursor.xml | 8 ++------ reference/ovrimos/functions/ovrimos-exec.xml | 6 +----- .../ovrimos/functions/ovrimos-execute.xml | 10 +++------- .../ovrimos/functions/ovrimos-fetch-into.xml | 20 +++++++++---------- .../ovrimos/functions/ovrimos-fetch-row.xml | 8 ++------ .../ovrimos/functions/ovrimos-field-len.xml | 12 ++++------- .../ovrimos/functions/ovrimos-field-name.xml | 8 ++------ .../ovrimos/functions/ovrimos-field-num.xml | 9 +++------ .../ovrimos/functions/ovrimos-field-type.xml | 9 +++------ .../ovrimos/functions/ovrimos-free-result.xml | 8 ++------ .../ovrimos/functions/ovrimos-longreadlen.xml | 8 ++------ .../ovrimos/functions/ovrimos-num-fields.xml | 8 ++------ .../ovrimos/functions/ovrimos-num-rows.xml | 6 +----- .../ovrimos/functions/ovrimos-prepare.xml | 5 +---- .../ovrimos/functions/ovrimos-result-all.xml | 16 ++++++--------- .../ovrimos/functions/ovrimos-result.xml | 11 ++++------ .../ovrimos/functions/ovrimos-rollback.xml | 9 +++------ 20 files changed, 61 insertions(+), 128 deletions(-) diff --git a/reference/ovrimos/functions/ovrimos-close.xml b/reference/ovrimos/functions/ovrimos-close.xml index 0d6eacab5c..bf210c47ab 100644 --- a/reference/ovrimos/functions/ovrimos-close.xml +++ b/reference/ovrimos/functions/ovrimos-close.xml @@ -1,5 +1,5 @@ - + @@ -14,11 +14,7 @@ ovrimos_close is used to close the specified - connection. - - - ovrimos_close closes a connection to - Ovrimos. This has the effect of rolling back uncommitted + connection to Ovrimos. This has the effect of rolling back uncommitted transactions. diff --git a/reference/ovrimos/functions/ovrimos-commit.xml b/reference/ovrimos/functions/ovrimos-commit.xml index 563c80d088..b0ebc3a236 100644 --- a/reference/ovrimos/functions/ovrimos-commit.xml +++ b/reference/ovrimos/functions/ovrimos-commit.xml @@ -1,5 +1,5 @@ - + @@ -9,15 +9,12 @@ Description - intovrimos_commit + boolovrimos_commit intconnection_id ovrimos_commit is used to commit the - transaction. - - - ovrimos_commit commits the transaction. + transaction. &return.success; diff --git a/reference/ovrimos/functions/ovrimos-connect.xml b/reference/ovrimos/functions/ovrimos-connect.xml index 692ef97190..9f4426e079 100644 --- a/reference/ovrimos/functions/ovrimos-connect.xml +++ b/reference/ovrimos/functions/ovrimos-connect.xml @@ -1,5 +1,5 @@ - + @@ -21,10 +21,11 @@ ovrimos_connect returns a connection id - (greater than 0) or 0 for failure. The meaning of 'host' and - 'port' are those used everywhere in Ovrimos APIs. 'Host' is a - host name or IP address and 'db' is either a database name, or a - string containing the port number. + (greater than 0) or 0 for failure. The meaning of + host and db are + those used everywhere in Ovrimos APIs. host + is a host name or IP address and db is either + a database name, or a string containing the port number. diff --git a/reference/ovrimos/functions/ovrimos-cursor.xml b/reference/ovrimos/functions/ovrimos-cursor.xml index 478d037e4b..73810c23d6 100644 --- a/reference/ovrimos/functions/ovrimos-cursor.xml +++ b/reference/ovrimos/functions/ovrimos-cursor.xml @@ -1,5 +1,5 @@ - + @@ -9,13 +9,9 @@ Description - intovrimos_cursor + stringovrimos_cursor intresult_id - - ovrimos_cursor is used to get the name of - the cursor. - ovrimos_cursor returns the name of the cursor. Useful when wishing to perform positioned updates or diff --git a/reference/ovrimos/functions/ovrimos-exec.xml b/reference/ovrimos/functions/ovrimos-exec.xml index d3b2f4b12f..d4ab69d2ba 100644 --- a/reference/ovrimos/functions/ovrimos-exec.xml +++ b/reference/ovrimos/functions/ovrimos-exec.xml @@ -1,5 +1,5 @@ - + @@ -13,10 +13,6 @@ intconnection_id stringquery - - ovrimos_exec is used to execute an SQL - statement. - ovrimos_exec executes an SQL statement (query or update) and returns a result_id or &false;. Evidently, diff --git a/reference/ovrimos/functions/ovrimos-execute.xml b/reference/ovrimos/functions/ovrimos-execute.xml index 1d1a0788a0..9cb7518ef7 100644 --- a/reference/ovrimos/functions/ovrimos-execute.xml +++ b/reference/ovrimos/functions/ovrimos-execute.xml @@ -1,5 +1,5 @@ - + @@ -13,13 +13,9 @@ intresult_id arrayparameters_array - - ovrimos_execute is used to execute an SQL - statement. - ovrimos_execute executes a prepared - statement. Returns &true; or &false;. + statement. &return.success; If the prepared statement contained parameters (question marks in the statement), the correct number of parameters should be passed in an array. Notice @@ -27,7 +23,7 @@ of the optional parameter inside square brackets. I couldn't bring myself on liking it. - + + @@ -15,22 +15,20 @@ stringhow intrownumber - - ovrimos_fetch_into is used to fetch a row - from the result set. - ovrimos_fetch_into fetches a row from the - result set into 'result_array', which should be passed by - reference. Which row is fetched is determined by the two last - parameters. 'how' is one of 'Next' (default), 'Prev', 'First', - 'Last', 'Absolute', corresponding to forward direction from + result set into result_array, which should + be passed by reference. Which row is fetched is determined by the + two last parameters. how is one of + Next (default), Prev, + First, Last, + Absolute, corresponding to forward direction from current position, backward direction from current position, forward direction from the start, backward direction from the end and absolute position from the start (essentially equivalent to 'first' but needs 'rownumber'). Case is not - significant. 'Rownumber' is optional except for absolute - positioning. Returns &true; or &false;. + significant. rownumber is optional except for + absolute positioning. &return.success; diff --git a/reference/ovrimos/functions/ovrimos-fetch-row.xml b/reference/ovrimos/functions/ovrimos-fetch-row.xml index a3fb8f2580..ed71f6f069 100644 --- a/reference/ovrimos/functions/ovrimos-fetch-row.xml +++ b/reference/ovrimos/functions/ovrimos-fetch-row.xml @@ -1,5 +1,5 @@ - + @@ -14,14 +14,10 @@ inthow introw_number - - ovrimos_fetch_row is used to fetch a row - from the result set. - ovrimos_fetch_row fetches a row from the result set. Column values should be retrieved with other - calls. Returns &true; or &false;. + calls. &return.success; diff --git a/reference/ovrimos/functions/ovrimos-field-len.xml b/reference/ovrimos/functions/ovrimos-field-len.xml index 69f74904e7..a2db7d18a2 100644 --- a/reference/ovrimos/functions/ovrimos-field-len.xml +++ b/reference/ovrimos/functions/ovrimos-field-len.xml @@ -1,5 +1,5 @@ - + @@ -15,14 +15,10 @@ ovrimos_field_len is used to get the length - of the output column with number field_number, - in result result_id. + of the output column with number field_number + (1-based), in result result_id. - - ovrimos_field_len returns the length of the - output column at the (1-based) index specified. - - + + @@ -9,14 +9,10 @@ Description - intovrimos_field_name + stringovrimos_field_name intresult_id intfield_number - - ovrimos_field_name is used to get the output - column name. - ovrimos_field_name returns the output column name at the (1-based) index specified. diff --git a/reference/ovrimos/functions/ovrimos-field-num.xml b/reference/ovrimos/functions/ovrimos-field-num.xml index cc1cd3e65b..6cccc622e7 100644 --- a/reference/ovrimos/functions/ovrimos-field-num.xml +++ b/reference/ovrimos/functions/ovrimos-field-num.xml @@ -1,5 +1,5 @@ - + @@ -15,13 +15,10 @@ intresult_id stringfield_name - - ovrimos_field_num is used to get the - (1-based) index of the output column. - ovrimos_field_num returns the (1-based) - index of the output column specified by name, or &false;. + index of the output column specified by field_name, + or &false;. diff --git a/reference/ovrimos/functions/ovrimos-field-type.xml b/reference/ovrimos/functions/ovrimos-field-type.xml index 7a8a3e6914..17f4ec7866 100644 --- a/reference/ovrimos/functions/ovrimos-field-type.xml +++ b/reference/ovrimos/functions/ovrimos-field-type.xml @@ -1,5 +1,5 @@ - + @@ -15,13 +15,10 @@ intresult_id intfield_number - - ovrimos_field_type is used to get the - (numeric) type of the output column. - ovrimos_field_type returns the (numeric) - type of the output column at the (1-based) index specified. + type of the output column at the (1-based) index specified by + field_number. diff --git a/reference/ovrimos/functions/ovrimos-free-result.xml b/reference/ovrimos/functions/ovrimos-free-result.xml index 3fa108bfaa..1b873c28a3 100644 --- a/reference/ovrimos/functions/ovrimos-free-result.xml +++ b/reference/ovrimos/functions/ovrimos-free-result.xml @@ -1,5 +1,5 @@ - + @@ -12,13 +12,9 @@ boolovrimos_free_result intresult_id - - ovrimos_free_result is used to free the - result_id. - ovrimos_free_result frees the specified - result_id result_id. Returns &true;. + result_id. Returns &true;. diff --git a/reference/ovrimos/functions/ovrimos-longreadlen.xml b/reference/ovrimos/functions/ovrimos-longreadlen.xml index 55a54b34b2..00a926ff76 100644 --- a/reference/ovrimos/functions/ovrimos-longreadlen.xml +++ b/reference/ovrimos/functions/ovrimos-longreadlen.xml @@ -1,5 +1,5 @@ - + @@ -11,14 +11,10 @@ Description - intovrimos_longreadlen + boolovrimos_longreadlen intresult_id intlength - - ovrimos_longreadlen is used to specify how - many bytes are to be retrieved from long datatypes. - ovrimos_longreadlen specifies how many bytes are to be retrieved from long datatypes (long varchar and long diff --git a/reference/ovrimos/functions/ovrimos-num-fields.xml b/reference/ovrimos/functions/ovrimos-num-fields.xml index fa789c7fe1..fecfe73b5e 100644 --- a/reference/ovrimos/functions/ovrimos-num-fields.xml +++ b/reference/ovrimos/functions/ovrimos-num-fields.xml @@ -1,5 +1,5 @@ - + @@ -12,13 +12,9 @@ intovrimos_num_fields intresult_id - - ovrimos_num_fields is used to get the number - of columns. - ovrimos_num_fields returns the number of - columns in a result_id resulting from a query. + columns in a result_id resulting from a query. diff --git a/reference/ovrimos/functions/ovrimos-num-rows.xml b/reference/ovrimos/functions/ovrimos-num-rows.xml index 41a05b2551..17816fa363 100644 --- a/reference/ovrimos/functions/ovrimos-num-rows.xml +++ b/reference/ovrimos/functions/ovrimos-num-rows.xml @@ -1,5 +1,5 @@ - + @@ -14,10 +14,6 @@ intovrimos_num_rows intresult_id - - ovrimos_num_rows is used to get the number - of rows affected by update operations. - ovrimos_num_rows returns the number of rows affected by update operations. diff --git a/reference/ovrimos/functions/ovrimos-prepare.xml b/reference/ovrimos/functions/ovrimos-prepare.xml index 0bea50f884..aaca844440 100644 --- a/reference/ovrimos/functions/ovrimos-prepare.xml +++ b/reference/ovrimos/functions/ovrimos-prepare.xml @@ -1,5 +1,5 @@ - + @@ -13,9 +13,6 @@ intconnection_id stringquery - - ovrimos_prepare is used to prepare an SQL statement. - ovrimos_prepare prepares an SQL statement and returns a result_id (or &false; on failure). diff --git a/reference/ovrimos/functions/ovrimos-result-all.xml b/reference/ovrimos/functions/ovrimos-result-all.xml index 3b42017501..c85bae4085 100644 --- a/reference/ovrimos/functions/ovrimos-result-all.xml +++ b/reference/ovrimos/functions/ovrimos-result-all.xml @@ -1,5 +1,5 @@ - + @@ -11,18 +11,14 @@ Description - boolovrimos_result_all + intovrimos_result_all intresult_id stringformat - - ovrimos_result_all is used to print an HTML - table containing the whole result set. - ovrimos_result_all prints the whole result - set as an HTML table. Returns &true; or - &false;. + set as an HTML table. Returns the number of rows in the generated + table. @@ -58,7 +54,7 @@ if ($conn != 0) { - Ovrimos_result_all with meta-information + <function>ovrimos_result_all</function> with meta-information - ovrimos_result_all example + <function>ovrimos_result_all</function> example - + @@ -9,17 +9,14 @@ Description - intovrimos_result + stringovrimos_result intresult_id mixedfield - - ovrimos_result is used to retrieve the - output column. - ovrimos_result retrieves the output column - specified by 'field', either as a string or as an 1-based index. + specified by field, either as a string or + as an 1-based index. Returns &false; on failure. diff --git a/reference/ovrimos/functions/ovrimos-rollback.xml b/reference/ovrimos/functions/ovrimos-rollback.xml index 6ac7b63b50..5df00af8d3 100644 --- a/reference/ovrimos/functions/ovrimos-rollback.xml +++ b/reference/ovrimos/functions/ovrimos-rollback.xml @@ -1,5 +1,5 @@ - + @@ -9,15 +9,12 @@ Description - intovrimos_rollback + boolovrimos_rollback intconnection_id ovrimos_rollback is used to roll back the - transaction. - - - ovrimos_rollback rolls back the transaction. + transaction. &return.succes;