WS, prepare for new doc style

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229082 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-02-06 00:08:49 +00:00
parent cd1f7c8ca1
commit 95103aebec
20 changed files with 475 additions and 485 deletions

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<refentry id="function.ovrimos-close">
<refnamediv>
<refname>ovrimos_close</refname>
<refpurpose>Closes the connection to ovrimos</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</para>
</refsect1>
</refentry>
<refentry id="function.ovrimos-close">
<refnamediv>
<refname>ovrimos_close</refname>
<refpurpose>Closes the connection to ovrimos</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,23 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<refentry id="function.ovrimos-commit">
<refnamediv>
<refname>ovrimos_commit</refname>
<refpurpose>Commits the transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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;
</para>
</refsect1>
</refentry>
<refentry id="function.ovrimos-commit">
<refnamediv>
<refname>ovrimos_commit</refname>
<refpurpose>Commits the transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,36 +1,36 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<refentry id="function.ovrimos-connect">
<refnamediv>
<refname>ovrimos_connect</refname>
<refpurpose>Connect to the specified database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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>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.
</para>
<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.
</para>
<para>
<example>
<title><function>ovrimos_connect</function> Example</title>
<programlisting role="php">
<refentry id="function.ovrimos-connect">
<refnamediv>
<refname>ovrimos_connect</refname>
<refpurpose>Connect to the specified database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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>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.
</para>
<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.
</para>
<para>
<example>
<title><function>ovrimos_connect</function> Example</title>
<programlisting role="php">
<![CDATA[
<?php
$conn = ovrimos_connect("server.domain.com", "8001", "admin", "password");
@ -46,13 +46,13 @@ if ($conn != 0) {
}
?>
]]>
</programlisting>
</example>
The above example will connect to the database and print out the
specified table.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
The above example will connect to the database and print out the
specified table.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<refentry id="function.ovrimos-cursor">
<refnamediv>
<refname>ovrimos_cursor</refname>
<refpurpose>Returns the name of the cursor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</para>
</refsect1>
</refentry>
<refentry id="function.ovrimos-cursor">
<refnamediv>
<refname>ovrimos_cursor</refname>
<refpurpose>Returns the name of the cursor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,25 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<refentry id="function.ovrimos-exec">
<refnamediv>
<refname>ovrimos_exec</refname>
<refpurpose>Executes an SQL statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</para>
</refsect1>
</refentry>
<refentry id="function.ovrimos-exec">
<refnamediv>
<refname>ovrimos_exec</refname>
<refpurpose>Executes an SQL statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,30 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<refentry id="function.ovrimos-execute">
<refnamediv>
<refname>ovrimos_execute</refname>
<refpurpose>Executes a prepared SQL statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</para>
</refsect1>
</refentry>
<refentry id="function.ovrimos-execute">
<refnamediv>
<refname>ovrimos_execute</refname>
<refpurpose>Executes a prepared SQL statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,39 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<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>
<methodsynopsis>
<type>bool</type><methodname>ovrimos_fetch_into</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">result_array</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>how</parameter></methodparam>
<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;
</para>
<para>
<example>
<title>A fetch into example</title>
<programlisting role="php">
<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>
<methodsynopsis>
<type>bool</type><methodname>ovrimos_fetch_into</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">result_array</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>how</parameter></methodparam>
<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;
</para>
<para>
<example>
<title>A fetch into example</title>
<programlisting role="php">
<![CDATA[
<?php
$conn=ovrimos_connect("neptune", "8001", "admin", "password");
@ -60,12 +60,12 @@ if ($conn!=0) {
}
?>
]]>
</programlisting>
</example>
This example will fetch a row.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
This example will fetch a row.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,28 +1,28 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<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>
<methodsynopsis>
<type>bool</type><methodname>ovrimos_fetch_row</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>how</parameter></methodparam>
<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;
</para>
<para>
<example>
<title>A fetch row example</title>
<programlisting role="php">
<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>
<methodsynopsis>
<type>bool</type><methodname>ovrimos_fetch_row</methodname>
<methodparam><type>int</type><parameter>result_id</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>how</parameter></methodparam>
<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;
</para>
<para>
<example>
<title>A fetch row example</title>
<programlisting role="php">
<![CDATA[
<?php
$conn = ovrimos_connect("remote.host", "8001", "admin", "password");
@ -51,12 +51,12 @@ if ($conn != 0) {
}
?>
]]>
</programlisting>
</example>
This will fetch a row and print the result.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
This will fetch a row and print the result.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,25 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<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>
<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>.
</para>
</refsect1>
</refentry>
<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>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<refentry id="function.ovrimos-field-name">
<refnamediv>
<refname>ovrimos_field_name</refname>
<refpurpose>Returns the output column name</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</para>
</refsect1>
</refentry>
<refentry id="function.ovrimos-field-name">
<refnamediv>
<refname>ovrimos_field_name</refname>
<refpurpose>Returns the output column name</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,27 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<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>
<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;.
</para>
</refsect1>
</refentry>
<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>
<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;.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,27 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<refentry id="function.ovrimos-field-type">
<refnamediv>
<refname>ovrimos_field_type</refname>
<refpurpose>
Returns the (numeric) type of the output column
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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>.
</para>
</refsect1>
</refentry>
<refentry id="function.ovrimos-field-type">
<refnamediv>
<refname>ovrimos_field_type</refname>
<refpurpose>Returns the (numeric) type of the output column</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,23 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<refentry id="function.ovrimos-free-result">
<refnamediv>
<refname>ovrimos_free_result</refname>
<refpurpose>Frees the specified result_id</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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;.
</para>
</refsect1>
</refentry>
<refentry id="function.ovrimos-free-result">
<refnamediv>
<refname>ovrimos_free_result</refname>
<refpurpose>Frees the specified result_id</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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;.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,28 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<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>
<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;.
</para>
</refsect1>
</refentry>
<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>
<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;.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,23 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<refentry id="function.ovrimos-num-fields">
<refnamediv>
<refname>ovrimos_num_fields</refname>
<refpurpose>Returns the number of columns</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</para>
</refsect1>
</refentry>
<refentry id="function.ovrimos-num-fields">
<refnamediv>
<refname>ovrimos_num_fields</refname>
<refpurpose>Returns the number of columns</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,25 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<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>
<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.
</para>
</refsect1>
</refentry>
<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>
<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.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,32 +1,32 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<refentry id="function.ovrimos-prepare">
<refnamediv>
<refname>ovrimos_prepare</refname>
<refpurpose>Prepares an SQL statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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).
</para>
<para>
<example>
<title>Connect to Ovrimos SQL Server and prepare a statement</title>
<programlisting role="php">
<refentry id="function.ovrimos-prepare">
<refnamediv>
<refname>ovrimos_prepare</refname>
<refpurpose>Prepares an SQL statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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).
</para>
<para>
<example>
<title>Connect to Ovrimos SQL Server and prepare a statement</title>
<programlisting role="php">
<![CDATA[
<?php
$conn=ovrimos_connect("db_host", "8001", "admin", "password");
if ($conn!=0) {
echo "Connection ok!";
$res=ovrimos_prepare($conn, "select table_id, table_name
$res=ovrimos_prepare($conn, "select table_id, table_name
from sys.tables where table_id=1");
if ($res != 0) {
echo "Prepare ok!";
@ -44,13 +44,13 @@ if ($conn!=0) {
}
?>
]]>
</programlisting>
</example>
This will connect to Ovrimos SQL Server, prepare a statement and
the execute it.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
This will connect to Ovrimos SQL Server, prepare a statement and
the execute it.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,35 +1,33 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<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>
<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.
</para>
<para>
<example>
<title>Prepare a statement, execute, and view the result</title>
<programlisting role="php">
<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>
<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.
</para>
<para>
<example>
<title>Prepare a statement, execute, and view the result</title>
<programlisting role="php">
<![CDATA[
<?php
$conn = ovrimos_connect("db_host", "8001", "admin", "password");
if ($conn != 0) {
echo "Connection ok!";
$res = ovrimos_prepare($conn, "select table_id, table_name
$res = ovrimos_prepare($conn, "select table_id, table_name
from sys.tables where table_id = 7");
if ($res != 0) {
echo "Prepare ok!";
@ -47,21 +45,21 @@ if ($conn != 0) {
}
?>
]]>
</programlisting>
</example>
This will execute an SQL statement and print the result in an
HTML table.
</para>
<para>
<example>
<title><function>ovrimos_result_all</function> with meta-information</title>
<programlisting role="php">
</programlisting>
</example>
This will execute an SQL statement and print the result in an
HTML table.
</para>
<para>
<example>
<title><function>ovrimos_result_all</function> with meta-information</title>
<programlisting role="php">
<![CDATA[
<?php
$conn = ovrimos_connect("db_host", "8001", "admin", "password");
if ($conn != 0) {
echo "Connection ok!";
$res = ovrimos_exec($conn, "select table_id, table_name
$res = ovrimos_exec($conn, "select table_id, table_name
from sys.tables where table_id = 1");
if ($res != 0) {
echo "Statement ok! cursor=" . ovrimos_cursor($res) . "\n";
@ -70,7 +68,7 @@ if ($conn != 0) {
for ($i=1; $i <= $colnb; $i++) {
$name = ovrimos_field_name($res, $i);
$type = ovrimos_field_type($res, $i);
$len = ovrimos_field_len($res, $i);
$len = ovrimos_field_len($res, $i);
echo "Column " . $i . " name=" . $name . " type=" . $type . " len=" . $len . "\n";
}
ovrimos_result_all($res);
@ -80,13 +78,13 @@ if ($conn != 0) {
}
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title><function>ovrimos_result_all</function> example</title>
<programlisting role="php">
</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");
@ -102,11 +100,11 @@ if ($conn != 0) {
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,25 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<refentry id="function.ovrimos-result">
<refnamediv>
<refname>ovrimos_result</refname>
<refpurpose>Retrieves the output column</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</para>
</refsect1>
</refentry>
<refentry id="function.ovrimos-result">
<refnamediv>
<refname>ovrimos_result</refname>
<refpurpose>Retrieves the output column</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,23 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
<refentry id="function.ovrimos-rollback">
<refnamediv>
<refname>ovrimos_rollback</refname>
<refpurpose>Rolls back the transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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;
</para>
</refsect1>
</refentry>
<refentry id="function.ovrimos-rollback">
<refnamediv>
<refname>ovrimos_rollback</refname>
<refpurpose>Rolls back the transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: