didou Tue Feb 6 00:09:17 2007 UTC
Modified files:
/phpdoc/en/reference/ovrimos/functions ovrimos-close.xml
ovrimos-commit.xml
ovrimos-connect.xml
ovrimos-cursor.xml
ovrimos-exec.xml
ovrimos-execute.xml
ovrimos-fetch-into.xml
ovrimos-fetch-row.xml
ovrimos-field-len.xml
ovrimos-field-name.xml
ovrimos-field-num.xml
ovrimos-field-type.xml
ovrimos-free-result.xml
ovrimos-longreadlen.xml
ovrimos-num-fields.xml
ovrimos-num-rows.xml
ovrimos-prepare.xml
ovrimos-result-all.xml
ovrimos-result.xml
ovrimos-rollback.xml
Log:
ref.ovrimos: switch to new style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-close.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-close.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-close.xml:1.4
phpdoc/en/reference/ovrimos/functions/ovrimos-close.xml:1.5
--- phpdoc/en/reference/ovrimos/functions/ovrimos-close.xml:1.4 Tue Feb 6
00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-close.xml Tue Feb 6
00:09:17 2007
@@ -1,23 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.ovrimos-close">
<refnamediv>
<refname>ovrimos_close</refname>
<refpurpose>Closes the connection to ovrimos</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>void</type><methodname>ovrimos_close</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_close</function> is used to close the specified
- connection to Ovrimos. This has the effect of rolling back uncommitted
- transactions.
+ Closes the specified <parameter>connection</parameter> to Ovrimos. This
+ has the effect of rolling back uncommitted transactions.
</para>
</refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>connection</parameter></term>
+ <listitem>
+ <para>
+ The Ovrimos connection identifier, returned by
+ <function>ovrimos_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-commit.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-commit.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-commit.xml:1.4
phpdoc/en/reference/ovrimos/functions/ovrimos-commit.xml:1.5
--- phpdoc/en/reference/ovrimos/functions/ovrimos-commit.xml:1.4 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-commit.xml Tue Feb 6
00:09:17 2007
@@ -1,20 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.ovrimos-commit">
<refnamediv>
<refname>ovrimos_commit</refname>
<refpurpose>Commits the transaction</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ovrimos_commit</methodname>
<methodparam><type>int</type><parameter>connection_id</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_commit</function> is used to commit the
- transaction. &return.success;
+ Commits the transaction.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>connection_id</parameter></term>
+ <listitem>
+ <para>
+ The Ovrimos connection identifier, returned by
+ <function>ovrimos_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-connect.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-connect.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-connect.xml:1.5
phpdoc/en/reference/ovrimos/functions/ovrimos-connect.xml:1.6
--- phpdoc/en/reference/ovrimos/functions/ovrimos-connect.xml:1.5 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-connect.xml Tue Feb 6
00:09:17 2007
@@ -1,42 +1,85 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.ovrimos-connect">
<refnamediv>
<refname>ovrimos_connect</refname>
<refpurpose>Connect to the specified database</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ovrimos_connect</methodname>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
- <methodparam><type>string</type><parameter>db</parameter></methodparam>
+
<methodparam><type>string</type><parameter>dborport</parameter></methodparam>
<methodparam><type>string</type><parameter>user</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_connect</function> is used to connect to the
- specified database.
+ Connects to the specified database.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>host</parameter></term>
+ <listitem>
+ <para>
+ A host name or IP address.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>dborport</parameter></term>
+ <listitem>
+ <para>
+ Either a database name, or the port number to connect to.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user</parameter></term>
+ <listitem>
+ <para>
+ The user name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>password</parameter></term>
+ <listitem>
+ <para>
+ Password associated with <parameter>user</parameter>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
- <function>ovrimos_connect</function> returns a connection id
- (greater than 0) or 0 for failure. The meaning of
- <parameter>host</parameter> and <parameter>db</parameter> are
- those used everywhere in Ovrimos APIs. <parameter>host</parameter>
- is a host name or IP address and <parameter>db</parameter> is either
- a database name, or a string containing the port number.
+ Returns a connection identifier (greater than 0) on success, or 0 on
+ failure.
</para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>ovrimos_connect</function> Example</title>
<programlisting role="php">
<![CDATA[
<?php
-$conn = ovrimos_connect("server.domain.com", "8001", "admin", "password");
+$conn = ovrimos_connect("server.example.com", "8001", "admin", "password");
if ($conn != 0) {
echo "Connection ok!";
- $res=ovrimos_exec($conn, "select table_id, table_name from sys.tables");
+ $res = ovrimos_exec($conn, "select table_id, table_name from sys.tables");
if ($res != 0) {
echo "Statement ok!";
ovrimos_result_all($res);
@@ -48,8 +91,6 @@
]]>
</programlisting>
</example>
- The above example will connect to the database and print out the
- specified table.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-cursor.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-cursor.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-cursor.xml:1.4
phpdoc/en/reference/ovrimos/functions/ovrimos-cursor.xml:1.5
--- phpdoc/en/reference/ovrimos/functions/ovrimos-cursor.xml:1.4 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-cursor.xml Tue Feb 6
00:09:17 2007
@@ -1,21 +1,44 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.ovrimos-cursor">
<refnamediv>
<refname>ovrimos_cursor</refname>
<refpurpose>Returns the name of the cursor</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ovrimos_cursor</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_cursor</function> returns the name of the
- cursor. Useful when wishing to perform positioned updates or
- deletes.
+ Gets the name of the cursor. Useful when wishing to perform positioned
+ updates or deletes.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result_id</parameter></term>
+ <listitem>
+ <para>
+ A result identifier, returned by <function>ovrimos_execute</function>
+ or <function>ovrimos_exec</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the name as a string, or &false; on error.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-exec.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-exec.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-exec.xml:1.4
phpdoc/en/reference/ovrimos/functions/ovrimos-exec.xml:1.5
--- phpdoc/en/reference/ovrimos/functions/ovrimos-exec.xml:1.4 Tue Feb 6
00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-exec.xml Tue Feb 6
00:09:17 2007
@@ -1,24 +1,57 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.ovrimos-exec">
<refnamediv>
<refname>ovrimos_exec</refname>
<refpurpose>Executes an SQL statement</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ovrimos_exec</methodname>
<methodparam><type>int</type><parameter>connection_id</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_exec</function> executes an SQL statement
- (query or update) and returns a result_id or &false;. Evidently,
- the SQL statement should not contain parameters.
+ Executes an SQL statement (query or update) and returns a result
+ identifier.
</para>
</refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>connection_id</parameter></term>
+ <listitem>
+ <para>
+ The Ovrimos connection identifier, returned by
+ <function>ovrimos_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>query</parameter></term>
+ <listitem>
+ <para>
+ The SQL statement. Evidently, it should not contain parameters.
+ Use <function>ovrimos_prepare</function> for prepared statements.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the result identifier as an integer, or &false; on error.
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-execute.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-execute.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-execute.xml:1.4
phpdoc/en/reference/ovrimos/functions/ovrimos-execute.xml:1.5
--- phpdoc/en/reference/ovrimos/functions/ovrimos-execute.xml:1.4 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-execute.xml Tue Feb 6
00:09:17 2007
@@ -1,27 +1,54 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.ovrimos-execute">
<refnamediv>
<refname>ovrimos_execute</refname>
<refpurpose>Executes a prepared SQL statement</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ovrimos_execute</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
<methodparam
choice="opt"><type>array</type><parameter>parameters_array</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_execute</function> 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.
+ Executes a prepared statement.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result_id</parameter></term>
+ <listitem>
+ <para>
+ An Ovrimos result identifier prepared with
+ <function>ovrimos_prepare</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>parameters_array</parameter></term>
+ <listitem>
+ <para>
+ If the prepared statement contained parameters (question marks in the
+ statement), the correct number of parameters should be passed in an
+ array.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-fetch-into.xml?r1=1.7&r2=1.8&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-fetch-into.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-fetch-into.xml:1.7
phpdoc/en/reference/ovrimos/functions/ovrimos-fetch-into.xml:1.8
--- phpdoc/en/reference/ovrimos/functions/ovrimos-fetch-into.xml:1.7 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-fetch-into.xml Tue Feb
6 00:09:17 2007
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.8 $ -->
<refentry id="function.ovrimos-fetch-into">
<refnamediv>
<refname>ovrimos_fetch_into</refname>
<refpurpose>Fetches a row from the result set</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ovrimos_fetch_into</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
@@ -16,20 +16,109 @@
<methodparam
choice="opt"><type>int</type><parameter>rownumber</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_fetch_into</function> fetches a row from the
- result set into <parameter>result_array</parameter>, which should
- be passed by reference. Which row is fetched is determined by the
- two last parameters. <parameter>how</parameter> is one of
- <literal>Next</literal> (default), <literal>Prev</literal>,
- <literal>First</literal>, <literal>Last</literal>,
- <literal>Absolute</literal>, 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. <parameter>rownumber</parameter> is optional except for
- absolute positioning. &return.success;
+ Fetches a row from the given result set, into
+ <parameter>result_array</parameter>.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result_id</parameter></term>
+ <listitem>
+ <para>
+ A result identifier, returned by <function>ovrimos_execute</function>
+ or <function>ovrimos_exec</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>result_array</parameter></term>
+ <listitem>
+ <para>
+ You must provide an array by reference. It will be filled with the
+ fetched values.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>how</parameter></term>
+ <listitem>
+ <para>
+ Determines how the rows are fetched. This can be one of the following
+ strings (case is not significant):
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Notes</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>Next</literal></entry>
+ <entry>
+ Forward direction from current position.
+ This is the default value.
+ </entry>
+ </row>
+ <row>
+ <entry><literal>Prev</literal></entry>
+ <entry>
+ Backward direction from current position.
+ </entry>
+ </row>
+ <row>
+ <entry><literal>First</literal></entry>
+ <entry>
+ Forward direction from the start.
+ </entry>
+ </row>
+ <row>
+ <entry><literal>Last</literal></entry>
+ <entry>
+ Backward direction from the end.
+ </entry>
+ </row>
+ <row>
+ <entry><literal>Absolute</literal></entry>
+ <entry>
+ Absolute position from the start.
+ Requires <parameter>rownumber</parameter>.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>rownumber</parameter></term>
+ <listitem>
+ <para>
+ The row number, first one is 0. Only needed when
+ <parameter>how</parameter> is set to
+ <literal>Absolute</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title>A fetch into example</title>
@@ -62,7 +151,6 @@
]]>
</programlisting>
</example>
- This example will fetch a row.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-fetch-row.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-fetch-row.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-fetch-row.xml:1.5
phpdoc/en/reference/ovrimos/functions/ovrimos-fetch-row.xml:1.6
--- phpdoc/en/reference/ovrimos/functions/ovrimos-fetch-row.xml:1.5 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-fetch-row.xml Tue Feb 6
00:09:17 2007
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.ovrimos-fetch-row">
<refnamediv>
<refname>ovrimos_fetch_row</refname>
<refpurpose>Fetches a row from the result set</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ovrimos_fetch_row</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
@@ -15,10 +15,100 @@
<methodparam
choice="opt"><type>int</type><parameter>row_number</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_fetch_row</function> fetches a row from the
- result set. Column values should be retrieved with other
- calls. &return.success;
+ Fetches a row from the result set. Column values should be retrieved with
+ other calls.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result_id</parameter></term>
+ <listitem>
+ <para>
+ A result identifier, returned by <function>ovrimos_execute</function>
+ or <function>ovrimos_exec</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>how</parameter></term>
+ <listitem>
+ <para>
+ Determines how the rows are fetched. This can be one of the following
+ strings (case is not significant):
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Notes</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>Next</literal></entry>
+ <entry>
+ Forward direction from current position.
+ This is the default value.
+ </entry>
+ </row>
+ <row>
+ <entry><literal>Prev</literal></entry>
+ <entry>
+ Backward direction from current position.
+ </entry>
+ </row>
+ <row>
+ <entry><literal>First</literal></entry>
+ <entry>
+ Forward direction from the start.
+ </entry>
+ </row>
+ <row>
+ <entry><literal>Last</literal></entry>
+ <entry>
+ Backward direction from the end.
+ </entry>
+ </row>
+ <row>
+ <entry><literal>Absolute</literal></entry>
+ <entry>
+ Absolute position from the start.
+ Requires <parameter>rownumber</parameter>.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>rownumber</parameter></term>
+ <listitem>
+ <para>
+ The row number, first one is 0. Only needed when
+ <parameter>how</parameter> is set to
+ <literal>Absolute</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title>A fetch row example</title>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-field-len.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-field-len.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-field-len.xml:1.4
phpdoc/en/reference/ovrimos/functions/ovrimos-field-len.xml:1.5
--- phpdoc/en/reference/ovrimos/functions/ovrimos-field-len.xml:1.4 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-field-len.xml Tue Feb 6
00:09:17 2007
@@ -1,22 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.ovrimos-field-len">
<refnamediv>
<refname>ovrimos_field_len</refname>
<refpurpose>Returns the length of the output column</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ovrimos_field_len</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_field_len</function> is used to get the length
- of the output column with number <parameter>field_number</parameter>
- (1-based), in result <parameter>result_id</parameter>.
+ Gets the length of the specified output column.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result_id</parameter></term>
+ <listitem>
+ <para>
+ A result identifier, returned by <function>ovrimos_execute</function>
+ or <function>ovrimos_exec</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>field_number</parameter></term>
+ <listitem>
+ <para>
+ The field number. Starts at 1.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the length as an interger, or &false; on error.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-field-name.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-field-name.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-field-name.xml:1.4
phpdoc/en/reference/ovrimos/functions/ovrimos-field-name.xml:1.5
--- phpdoc/en/reference/ovrimos/functions/ovrimos-field-name.xml:1.4 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-field-name.xml Tue Feb
6 00:09:17 2007
@@ -1,21 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.ovrimos-field-name">
<refnamediv>
<refname>ovrimos_field_name</refname>
<refpurpose>Returns the output column name</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ovrimos_field_name</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_field_name</function> returns the output column
- name at the (1-based) index specified.
+ Returns the output column name at the index specified.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result_id</parameter></term>
+ <listitem>
+ <para>
+ A result identifier, returned by <function>ovrimos_execute</function>
+ or <function>ovrimos_exec</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>field_number</parameter></term>
+ <listitem>
+ <para>
+ The field number. Starts at 1.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the field name as a string, or &false; on error.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-field-num.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-field-num.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-field-num.xml:1.4
phpdoc/en/reference/ovrimos/functions/ovrimos-field-num.xml:1.5
--- phpdoc/en/reference/ovrimos/functions/ovrimos-field-num.xml:1.4 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-field-num.xml Tue Feb 6
00:09:17 2007
@@ -1,22 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.ovrimos-field-num">
<refnamediv>
<refname>ovrimos_field_num</refname>
<refpurpose>Returns the (1-based) index of the output column</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ovrimos_field_num</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
<methodparam><type>string</type><parameter>field_name</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_field_num</function> returns the (1-based)
- index of the output column specified by <parameter>field_name</parameter>,
- or &false;.
+ Returns the 1-based index of the specified output column.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result_id</parameter></term>
+ <listitem>
+ <para>
+ A result identifier, returned by <function>ovrimos_execute</function>
+ or <function>ovrimos_exec</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>field_name</parameter></term>
+ <listitem>
+ <para>
+ The field name.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the index, starting at 1, or &false; on error.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-field-type.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-field-type.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-field-type.xml:1.4
phpdoc/en/reference/ovrimos/functions/ovrimos-field-type.xml:1.5
--- phpdoc/en/reference/ovrimos/functions/ovrimos-field-type.xml:1.4 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-field-type.xml Tue Feb
6 00:09:17 2007
@@ -1,22 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.ovrimos-field-type">
<refnamediv>
<refname>ovrimos_field_type</refname>
- <refpurpose>Returns the (numeric) type of the output column</refpurpose>
+ <refpurpose>Returns the type of the output column</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ovrimos_field_type</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_field_type</function> returns the (numeric)
- type of the output column at the (1-based) index specified by
- <parameter>field_number</parameter>.
+ Returns the type of the output column
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result_id</parameter></term>
+ <listitem>
+ <para>
+ A result identifier, returned by <function>ovrimos_execute</function>
+ or <function>ovrimos_exec</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>field_number</parameter></term>
+ <listitem>
+ <para>
+ A 1-based index.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the field type as an integer, or &false; on error.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-free-result.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-free-result.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-free-result.xml:1.4
phpdoc/en/reference/ovrimos/functions/ovrimos-free-result.xml:1.5
--- phpdoc/en/reference/ovrimos/functions/ovrimos-free-result.xml:1.4 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-free-result.xml Tue Feb
6 00:09:17 2007
@@ -1,20 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.ovrimos-free-result">
<refnamediv>
<refname>ovrimos_free_result</refname>
<refpurpose>Frees the specified result_id</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ovrimos_free_result</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_free_result</function> frees the specified
- <parameter>result_id</parameter>. Returns &true;.
+ Frees the specified result identifier.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result_id</parameter></term>
+ <listitem>
+ <para>
+ A result identifier, returned by <function>ovrimos_execute</function>
+ or <function>ovrimos_exec</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns &true;.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-longreadlen.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-longreadlen.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-longreadlen.xml:1.4
phpdoc/en/reference/ovrimos/functions/ovrimos-longreadlen.xml:1.5
--- phpdoc/en/reference/ovrimos/functions/ovrimos-longreadlen.xml:1.4 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-longreadlen.xml Tue Feb
6 00:09:17 2007
@@ -1,23 +1,53 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.ovrimos-longreadlen">
<refnamediv>
<refname>ovrimos_longreadlen</refname>
<refpurpose>Specifies how many bytes are to be retrieved from long
datatypes</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ovrimos_longreadlen</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_longreadlen</function> 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;.
+ Specifies how many bytes are to be retrieved from long datatypes (long
+ varchar and long varbinary).
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result_id</parameter></term>
+ <listitem>
+ <para>
+ A result identifier, returned by <function>ovrimos_execute</function>
+ or <function>ovrimos_exec</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>length</parameter></term>
+ <listitem>
+ <para>
+ The number of bytes to retrieve. Default is zero.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns &true;.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-num-fields.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-num-fields.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-num-fields.xml:1.4
phpdoc/en/reference/ovrimos/functions/ovrimos-num-fields.xml:1.5
--- phpdoc/en/reference/ovrimos/functions/ovrimos-num-fields.xml:1.4 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-num-fields.xml Tue Feb
6 00:09:17 2007
@@ -1,20 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.ovrimos-num-fields">
<refnamediv>
<refname>ovrimos_num_fields</refname>
<refpurpose>Returns the number of columns</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ovrimos_num_fields</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_num_fields</function> returns the number of
- columns in a <parameter>result_id</parameter> resulting from a query.
+ Returns the number of columns in the specified result identifier.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result_id</parameter></term>
+ <listitem>
+ <para>
+ A result identifier, returned by <function>ovrimos_execute</function>
+ or <function>ovrimos_exec</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the number of columns as an integer, or &false; on error.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-num-rows.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-num-rows.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-num-rows.xml:1.4
phpdoc/en/reference/ovrimos/functions/ovrimos-num-rows.xml:1.5
--- phpdoc/en/reference/ovrimos/functions/ovrimos-num-rows.xml:1.4 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-num-rows.xml Tue Feb 6
00:09:17 2007
@@ -1,20 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.ovrimos-num-rows">
<refnamediv>
<refname>ovrimos_num_rows</refname>
<refpurpose>Returns the number of rows affected by update
operations</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ovrimos_num_rows</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_num_rows</function> returns the number of rows
- affected by update operations.
+ Gets the number of rows affected by update operations.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result_id</parameter></term>
+ <listitem>
+ <para>
+ A result identifier, returned by <function>ovrimos_execute</function>
+ or <function>ovrimos_exec</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the number of rows as an integer, or &false; on error.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-prepare.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-prepare.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-prepare.xml:1.5
phpdoc/en/reference/ovrimos/functions/ovrimos-prepare.xml:1.6
--- phpdoc/en/reference/ovrimos/functions/ovrimos-prepare.xml:1.5 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-prepare.xml Tue Feb 6
00:09:17 2007
@@ -1,35 +1,73 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.ovrimos-prepare">
<refnamediv>
<refname>ovrimos_prepare</refname>
<refpurpose>Prepares an SQL statement</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ovrimos_prepare</methodname>
<methodparam><type>int</type><parameter>connection_id</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_prepare</function> prepares an SQL statement
- and returns a result_id (or &false; on failure).
+ Prepares an SQL statement.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>connection_id</parameter></term>
+ <listitem>
+ <para>
+ The Ovrimos connection identifier, returned by
+ <function>ovrimos_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>query</parameter></term>
+ <listitem>
+ <para>
+ The SQL statement.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a result identifier on success, or &false; on error.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
- <title>Connect to Ovrimos SQL Server and prepare a statement</title>
+ <title><function>ovrimos_prepare</function> Example</title>
<programlisting role="php">
<![CDATA[
<?php
$conn=ovrimos_connect("db_host", "8001", "admin", "password");
if ($conn!=0) {
echo "Connection ok!";
+
+ // Prepare the statement
$res=ovrimos_prepare($conn, "select table_id, table_name
from sys.tables where table_id=1");
if ($res != 0) {
echo "Prepare ok!";
+ // Execute the prepared statement
if (ovrimos_execute($res)) {
echo "Execute ok!\n";
ovrimos_result_all($res);
@@ -46,8 +84,6 @@
]]>
</programlisting>
</example>
- This will connect to Ovrimos SQL Server, prepare a statement and
- the execute it.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-result-all.xml?r1=1.7&r2=1.8&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-result-all.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-result-all.xml:1.7
phpdoc/en/reference/ovrimos/functions/ovrimos-result-all.xml:1.8
--- phpdoc/en/reference/ovrimos/functions/ovrimos-result-all.xml:1.7 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-result-all.xml Tue Feb
6 00:09:17 2007
@@ -1,24 +1,60 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.8 $ -->
<refentry id="function.ovrimos-result-all">
<refnamediv>
<refname>ovrimos_result_all</refname>
<refpurpose>Prints the whole result set as an HTML table</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ovrimos_result_all</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_result_all</function> prints the whole result
- set as an HTML table. Returns the number of rows in the generated
- table.
+ Prints the whole result set as an HTML table.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result_id</parameter></term>
+ <listitem>
+ <para>
+ A result identifier, returned by <function>ovrimos_execute</function>
+ or <function>ovrimos_exec</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>format</parameter></term>
+ <listitem>
+ <para>
+ Optional HTML attributes for the generated table element.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the number of rows in the generated table.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
+ This will execute an SQL statement and print the result in an
+ HTML table.
<example>
<title>Prepare a statement, execute, and view the result</title>
<programlisting role="php">
@@ -47,8 +83,6 @@
]]>
</programlisting>
</example>
- This will execute an SQL statement and print the result in an
- HTML table.
</para>
<para>
<example>
@@ -81,28 +115,6 @@
</programlisting>
</example>
</para>
- <para>
- <example>
- <title><function>ovrimos_result_all</function> example</title>
- <programlisting role="php">
-<![CDATA[
-<?php
-$conn = ovrimos_connect("db_host", "8001", "admin", "password");
-if ($conn != 0) {
- echo "Connection ok!";
- $res = ovrimos_exec($conn, "update test set i=5");
- if ($res != 0) {
- echo "Statement ok!";
- echo ovrimos_num_rows($res)." rows affected\n";
- ovrimos_free_result($res);
- }
- ovrimos_close($conn);
-}
-?>
-]]>
- </programlisting>
- </example>
- </para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-result.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-result.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-result.xml:1.4
phpdoc/en/reference/ovrimos/functions/ovrimos-result.xml:1.5
--- phpdoc/en/reference/ovrimos/functions/ovrimos-result.xml:1.4 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-result.xml Tue Feb 6
00:09:17 2007
@@ -1,22 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.ovrimos-result">
<refnamediv>
<refname>ovrimos_result</refname>
<refpurpose>Retrieves the output column</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ovrimos_result</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
<methodparam><type>mixed</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_result</function> retrieves the output column
- specified by <parameter>field</parameter>, either as a string or
- as an 1-based index. Returns &false; on failure.
+ Retrieves the output column specified by <parameter>field</parameter>.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>result_id</parameter></term>
+ <listitem>
+ <para>
+ A result identifier, returned by <function>ovrimos_execute</function>
+ or <function>ovrimos_exec</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>field</parameter></term>
+ <listitem>
+ <para>
+ Either as a string with the field name or as an 1-based index.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the column as a string, &false; on failure.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ovrimos/functions/ovrimos-rollback.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/ovrimos/functions/ovrimos-rollback.xml
diff -u phpdoc/en/reference/ovrimos/functions/ovrimos-rollback.xml:1.5
phpdoc/en/reference/ovrimos/functions/ovrimos-rollback.xml:1.6
--- phpdoc/en/reference/ovrimos/functions/ovrimos-rollback.xml:1.5 Tue Feb
6 00:08:49 2007
+++ phpdoc/en/reference/ovrimos/functions/ovrimos-rollback.xml Tue Feb 6
00:09:17 2007
@@ -1,20 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
-<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.ovrimos-rollback">
<refnamediv>
<refname>ovrimos_rollback</refname>
<refpurpose>Rolls back the transaction</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ovrimos_rollback</methodname>
<methodparam><type>int</type><parameter>connection_id</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ovrimos_rollback</function> is used to roll back the
- transaction. &return.success;
+ Rolls back the transaction.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>connection_id</parameter></term>
+ <listitem>
+ <para>
+ The Ovrimos connection identifier, returned by
+ <function>ovrimos_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
</para>
</refsect1>
</refentry>
