From 95103aebec3a19dbcfc487cd77c1452053d6f4c2 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Tue, 6 Feb 2007 00:08:49 +0000 Subject: [PATCH] WS, prepare for new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229082 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/ovrimos/functions/ovrimos-close.xml | 38 ++++---- .../ovrimos/functions/ovrimos-commit.xml | 36 +++---- .../ovrimos/functions/ovrimos-connect.xml | 76 +++++++-------- .../ovrimos/functions/ovrimos-cursor.xml | 38 ++++---- reference/ovrimos/functions/ovrimos-exec.xml | 40 ++++---- .../ovrimos/functions/ovrimos-execute.xml | 50 +++++----- .../ovrimos/functions/ovrimos-fetch-into.xml | 80 ++++++++-------- .../ovrimos/functions/ovrimos-fetch-row.xml | 58 ++++++------ .../ovrimos/functions/ovrimos-field-len.xml | 40 ++++---- .../ovrimos/functions/ovrimos-field-name.xml | 38 ++++---- .../ovrimos/functions/ovrimos-field-num.xml | 42 ++++----- .../ovrimos/functions/ovrimos-field-type.xml | 42 ++++----- .../ovrimos/functions/ovrimos-free-result.xml | 36 +++---- .../ovrimos/functions/ovrimos-longreadlen.xml | 44 +++++---- .../ovrimos/functions/ovrimos-num-fields.xml | 36 +++---- .../ovrimos/functions/ovrimos-num-rows.xml | 38 ++++---- .../ovrimos/functions/ovrimos-prepare.xml | 58 ++++++------ .../ovrimos/functions/ovrimos-result-all.xml | 94 +++++++++---------- .../ovrimos/functions/ovrimos-result.xml | 40 ++++---- .../ovrimos/functions/ovrimos-rollback.xml | 36 +++---- 20 files changed, 475 insertions(+), 485 deletions(-) diff --git a/reference/ovrimos/functions/ovrimos-close.xml b/reference/ovrimos/functions/ovrimos-close.xml index bf210c47ab..79831d6d06 100644 --- a/reference/ovrimos/functions/ovrimos-close.xml +++ b/reference/ovrimos/functions/ovrimos-close.xml @@ -1,24 +1,24 @@ - + - - - ovrimos_close - Closes the connection to ovrimos - - - Description - - voidovrimos_close - intconnection - - - ovrimos_close is used to close the specified - connection to Ovrimos. This has the effect of rolling back uncommitted - transactions. - - - + + + ovrimos_close + Closes the connection to ovrimos + + + Description + + voidovrimos_close + intconnection + + + ovrimos_close is used to close the specified + connection to Ovrimos. This has the effect of rolling back uncommitted + transactions. + + + + - - - ovrimos_commit - Commits the transaction - - - Description - - boolovrimos_commit - intconnection_id - - - ovrimos_commit is used to commit the - transaction. &return.success; - - - + + + ovrimos_commit + Commits the transaction + + + Description + + boolovrimos_commit + intconnection_id + + + ovrimos_commit is used to commit the + transaction. &return.success; + + + + - - - ovrimos_connect - Connect to the specified database - - - Description - - intovrimos_connect - stringhost - stringdb - stringuser - stringpassword - - - ovrimos_connect is used to connect to the - specified database. - - - ovrimos_connect returns a connection id - (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. - - - - <function>ovrimos_connect</function> Example - + + + ovrimos_connect + Connect to the specified database + + + Description + + intovrimos_connect + stringhost + stringdb + stringuser + stringpassword + + + ovrimos_connect is used to connect to the + specified database. + + + ovrimos_connect returns a connection id + (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. + + + + <function>ovrimos_connect</function> Example + ]]> - - - The above example will connect to the database and print out the - specified table. - - - + + + The above example will connect to the database and print out the + specified table. + + + + - - - ovrimos_cursor - Returns the name of the cursor - - - Description - - stringovrimos_cursor - intresult_id - - - ovrimos_cursor returns the name of the - cursor. Useful when wishing to perform positioned updates or - deletes. - - - + + + ovrimos_cursor + Returns the name of the cursor + + + Description + + stringovrimos_cursor + intresult_id + + + ovrimos_cursor returns the name of the + cursor. Useful when wishing to perform positioned updates or + deletes. + + + + - - - ovrimos_exec - Executes an SQL statement - - - Description - - intovrimos_exec - intconnection_id - stringquery - - - ovrimos_exec executes an SQL statement - (query or update) and returns a result_id or &false;. Evidently, - the SQL statement should not contain parameters. - - - + + + ovrimos_exec + Executes an SQL statement + + + Description + + intovrimos_exec + intconnection_id + stringquery + + + ovrimos_exec executes an SQL statement + (query or update) and returns a result_id or &false;. Evidently, + the SQL statement should not contain parameters. + + + + - - - ovrimos_execute - Executes a prepared SQL statement - - - Description - - boolovrimos_execute - intresult_id - arrayparameters_array - - - ovrimos_execute executes a prepared - 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 - that I don't follow the PHP convention of placing just the name - of the optional parameter inside square brackets. I couldn't - bring myself on liking it. - - - + + + ovrimos_execute + Executes a prepared SQL statement + + + Description + + boolovrimos_execute + intresult_id + arrayparameters_array + + + ovrimos_execute executes a prepared + 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 + that I don't follow the PHP convention of placing just the name + of the optional parameter inside square brackets. I couldn't + bring myself on liking it. + + + + - - - ovrimos_fetch_into - Fetches a row from the result set - - - Description - - boolovrimos_fetch_into - intresult_id - arrayresult_array - stringhow - intrownumber - - - 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 - 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. &return.success; - - - - A fetch into example - + + + ovrimos_fetch_into + Fetches a row from the result set + + + Description + + boolovrimos_fetch_into + intresult_id + arrayresult_array + stringhow + intrownumber + + + 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 + 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. &return.success; + + + + A fetch into example + ]]> - - - This example will fetch a row. - - - + + + This example will fetch a row. + + + + - - - ovrimos_fetch_row - Fetches a row from the result set - - - Description - - boolovrimos_fetch_row - intresult_id - inthow - introw_number - - - ovrimos_fetch_row fetches a row from the - result set. Column values should be retrieved with other - calls. &return.success; - - - - A fetch row example - + + + ovrimos_fetch_row + Fetches a row from the result set + + + Description + + boolovrimos_fetch_row + intresult_id + inthow + introw_number + + + ovrimos_fetch_row fetches a row from the + result set. Column values should be retrieved with other + calls. &return.success; + + + + A fetch row example + ]]> - - - This will fetch a row and print the result. - - - + + + This will fetch a row and print the result. + + + + - - - ovrimos_field_len - Returns the length of the output column - - - Description - - intovrimos_field_len - intresult_id - intfield_number - - - ovrimos_field_len is used to get the length - of the output column with number field_number - (1-based), in result result_id. - - - + + + ovrimos_field_len + Returns the length of the output column + + + Description + + intovrimos_field_len + intresult_id + intfield_number + + + ovrimos_field_len is used to get the length + of the output column with number field_number + (1-based), in result result_id. + + + + - - - ovrimos_field_name - Returns the output column name - - - Description - - stringovrimos_field_name - intresult_id - intfield_number - - - ovrimos_field_name returns the output column - name at the (1-based) index specified. - - - + + + ovrimos_field_name + Returns the output column name + + + Description + + stringovrimos_field_name + intresult_id + intfield_number + + + ovrimos_field_name returns the output column + name at the (1-based) index specified. + + + + - - - ovrimos_field_num - - Returns the (1-based) index of the output column - - - - Description - - intovrimos_field_num - intresult_id - stringfield_name - - - ovrimos_field_num returns the (1-based) - index of the output column specified by field_name, - or &false;. - - - + + + ovrimos_field_num + Returns the (1-based) index of the output column + + + Description + + intovrimos_field_num + intresult_id + stringfield_name + + + ovrimos_field_num returns the (1-based) + index of the output column specified by field_name, + or &false;. + + + + - - - ovrimos_field_type - - Returns the (numeric) type of the output column - - - - Description - - intovrimos_field_type - intresult_id - intfield_number - - - ovrimos_field_type returns the (numeric) - type of the output column at the (1-based) index specified by - field_number. - - - + + + ovrimos_field_type + Returns the (numeric) type of the output column + + + Description + + intovrimos_field_type + intresult_id + intfield_number + + + ovrimos_field_type returns the (numeric) + type of the output column at the (1-based) index specified by + field_number. + + + + - - - ovrimos_free_result - Frees the specified result_id - - - Description - - boolovrimos_free_result - intresult_id - - - ovrimos_free_result frees the specified - result_id. Returns &true;. - - - + + + ovrimos_free_result + Frees the specified result_id + + + Description + + boolovrimos_free_result + intresult_id + + + ovrimos_free_result frees the specified + result_id. Returns &true;. + + + + - - - ovrimos_longreadlen - - Specifies how many bytes are to be retrieved from long datatypes - - - - Description - - boolovrimos_longreadlen - intresult_id - intlength - - - ovrimos_longreadlen specifies how many bytes - are to be retrieved from long datatypes (long varchar and long - varbinary). Default is zero. It currently sets this parameter - the specified result set. Returns &true;. - - - + + + ovrimos_longreadlen + Specifies how many bytes are to be retrieved from long datatypes + + + Description + + boolovrimos_longreadlen + intresult_id + intlength + + + ovrimos_longreadlen specifies how many bytes + are to be retrieved from long datatypes (long varchar and long + varbinary). Default is zero. It currently sets this parameter + the specified result set. Returns &true;. + + + + - - - ovrimos_num_fields - Returns the number of columns - - - Description - - intovrimos_num_fields - intresult_id - - - ovrimos_num_fields returns the number of - columns in a result_id resulting from a query. - - - + + + ovrimos_num_fields + Returns the number of columns + + + Description + + intovrimos_num_fields + intresult_id + + + ovrimos_num_fields returns the number of + columns in a result_id resulting from a query. + + + + - - - ovrimos_num_rows - - Returns the number of rows affected by update operations - - - - Description - - intovrimos_num_rows - intresult_id - - - ovrimos_num_rows returns the number of rows - affected by update operations. - - - + + + ovrimos_num_rows + Returns the number of rows affected by update operations + + + Description + + intovrimos_num_rows + intresult_id + + + ovrimos_num_rows returns the number of rows + affected by update operations. + + + + - - - ovrimos_prepare - Prepares an SQL statement - - - Description - - intovrimos_prepare - intconnection_id - stringquery - - - ovrimos_prepare prepares an SQL statement - and returns a result_id (or &false; on failure). - - - - Connect to Ovrimos SQL Server and prepare a statement - + + + ovrimos_prepare + Prepares an SQL statement + + + Description + + intovrimos_prepare + intconnection_id + stringquery + + + ovrimos_prepare prepares an SQL statement + and returns a result_id (or &false; on failure). + + + + Connect to Ovrimos SQL Server and prepare a statement + ]]> - - - This will connect to Ovrimos SQL Server, prepare a statement and - the execute it. - - - + + + This will connect to Ovrimos SQL Server, prepare a statement and + the execute it. + + + + - - - ovrimos_result_all - - Prints the whole result set as an HTML table - - - - Description - - intovrimos_result_all - intresult_id - stringformat - - - ovrimos_result_all prints the whole result - set as an HTML table. Returns the number of rows in the generated - table. - - - - Prepare a statement, execute, and view the result - + + + ovrimos_result_all + Prints the whole result set as an HTML table + + + Description + + intovrimos_result_all + intresult_id + stringformat + + + ovrimos_result_all prints the whole result + set as an HTML table. Returns the number of rows in the generated + table. + + + + Prepare a statement, execute, and view the result + ]]> - - - This will execute an SQL statement and print the result in an - HTML table. - - - - <function>ovrimos_result_all</function> with meta-information - + + + This will execute an SQL statement and print the result in an + HTML table. + + + + <function>ovrimos_result_all</function> with meta-information + ]]> - - - - - - <function>ovrimos_result_all</function> example - + + + + + + <function>ovrimos_result_all</function> example + ]]> - - - - - + + + + + + - - - ovrimos_result - Retrieves the output column - - - Description - - stringovrimos_result - intresult_id - mixedfield - - - ovrimos_result retrieves the output column - specified by field, either as a string or - as an 1-based index. Returns &false; on failure. - - - + + + ovrimos_result + Retrieves the output column + + + Description + + stringovrimos_result + intresult_id + mixedfield + + + ovrimos_result retrieves the output column + specified by field, either as a string or + as an 1-based index. Returns &false; on failure. + + + + - - - ovrimos_rollback - Rolls back the transaction - - - Description - - boolovrimos_rollback - intconnection_id - - - ovrimos_rollback is used to roll back the - transaction. &return.success; - - - + + + ovrimos_rollback + Rolls back the transaction + + + Description + + boolovrimos_rollback + intconnection_id + + + ovrimos_rollback is used to roll back the + transaction. &return.success; + + +