sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-17 01:18:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

ref.maxdb: Finalize new style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237843 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-06-16 19:11:13 +00:00
parent 605cf6f383
commit f6863a9ad9
102 changed files with 1588 additions and 1035 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
reference/maxdb/functions/maxdb-affected-rows.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-affected-rows">
<refnamediv>
<refname>maxdb_affected_rows</refname>
<refname>maxdb->affected_rows</refname>
<refpurpose>Gets the number of affected rows in a previous MaxDB operation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>maxdb_affected_rows</methodname>
@ -35,8 +36,9 @@
<function>maxdb_num_rows</function> function instead.
</para>
</refsect1>
<refsect1>
<title>Return Values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An integer greater than zero indicates the number of rows affected or retrieved.
Zero indicates that no records where updated for an UPDATE statement, no rows matched
@ -44,15 +46,9 @@
-1 indicates that the number of rows affected can not be determined.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_num_rows</function>,
<function>maxdb_info</function>.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -156,6 +152,17 @@ Affected rows (SELECT): 15
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_num_rows</function></member>
<member><function>maxdb_info</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/maxdb/functions/maxdb-autocommit.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-autocommit">
<refnamediv>
<refname>maxdb_autocommit</refname>
<refname> maxdb->auto_commit</refname>
<refpurpose>Turns on or off auto-commiting database modifications</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_autocommit</methodname>
@ -29,21 +30,16 @@
resource.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_commit</function>,
<function>maxdb_rollback</function>.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -90,6 +86,17 @@ maxdb_close($link);
The above examples would produce no output.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_commit</function></member>
<member><function>maxdb_rollback</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

3
reference/maxdb/functions/maxdb-bind-param.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-bind-param">
<refnamediv>
<refname>maxdb_bind_param</refname>
@ -14,6 +14,7 @@
</simpara>
&info.function.alias.deprecated;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

3
reference/maxdb/functions/maxdb-bind-result.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-bind-result">
<refnamediv>
<refname>maxdb_bind_result</refname>
@ -14,6 +14,7 @@
</simpara>
&info.function.alias.deprecated;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/maxdb/functions/maxdb-change-user.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-change-user">
<refnamediv>
<refname>maxdb_change_user</refname>
<refname>maxdb->change_user</refname>
<refpurpose>Changes the user of the specified database connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_change_user</methodname>
@ -47,21 +48,16 @@
</para>
</note>
</refsect1>
<refsect1>
<title>Return Values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>See also:</title>
<para>
<function>maxdb_connect</function>
<function>maxdb_select_db</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -138,6 +134,17 @@ Database running
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_connect</function></member>
<member><function>maxdb_select_db</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/maxdb/functions/maxdb-character-set-name.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-character-set-name">
<refnamediv>
<refname>maxdb_character_set_name</refname>
<refname>maxdb->character_set_name</refname>
<refpurpose>Returns the default character set for the database connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>maxdb_character_set_name</methodname>
@ -27,19 +28,14 @@
<parameter>link</parameter> parameter.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>The default character set for the current connection, either ascii or unicode.</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_client_encoding</function>.
<function>maxdb_real_escape_string</function>.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -95,6 +91,17 @@ Current character set is ascii
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_client_encoding</function></member>
<member><function>maxdb_real_escape_string</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

3
reference/maxdb/functions/maxdb-client-encoding.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-client-encoding">
<refnamediv>
<refname>maxdb_client_encoding</refname>
@ -14,6 +14,7 @@
</simpara>
&info.function.alias.deprecated;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

3
reference/maxdb/functions/maxdb-close-long-data.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-close-long-data">
<refnamediv>
<refname>maxdb_close_long_data</refname>
@ -15,6 +15,7 @@
</simpara>
&info.function.alias.deprecated;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

26
reference/maxdb/functions/maxdb-close.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-close">
<refnamediv>
<refname>maxdb_close</refname>
<refname>maxdb->close</refname>
<refpurpose>Closes a previously opened database connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_close</methodname>
@ -27,20 +28,25 @@
connection specified by the <parameter>link</parameter> parameter.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>See also</title>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<function>maxdb_connect</function>,
<function>maxdb_init</function>,
<function>maxdb_real_connect</function>.
<simplelist>
<member><function>maxdb_connect</function></member>
<member><function>maxdb_init</function></member>
<member><function>maxdb_real_connect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/maxdb/functions/maxdb-commit.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-commit">
<refnamediv>
<refname>maxdb_commit</refname>
<refname>maxdb->commit</refname>
<refpurpose>Commits the current transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_commit</methodname>
@ -27,21 +28,16 @@
<parameter>link</parameter> parameter.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_autocommit</function>,
<function>maxdb_rollback</function>.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -116,6 +112,17 @@ maxdb_close($link);
The above examples produces no output.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_autocommit</function></member>
<member><function>maxdb_rollback</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

51
reference/maxdb/functions/maxdb-connect-errno.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-connect-errno">
<refnamediv>
<refname>maxdb_connect_errno</refname>
<refpurpose>Returns the error code from last connect call</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>maxdb_connect_errno</methodname>
<void />
@ -17,25 +18,17 @@
If no errors have occured, this function will return zero.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An error code value for the last call to <function>maxdb_connect</function>, if it failed.
zero means no error occurred.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_connect</function>,
<function>maxdb_connect_error</function>,
<function>maxdb_errno</function>,
<function>maxdb_error</function>,
<function>maxdb_sqlstate</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>maxdb_connect_errno sample</title>
@ -52,16 +45,30 @@ if (!$link) {
</programlisting>
</example>
</para>
<para>
The above example would produce the following output:
</para>
<screen>
<para>
The above example would produce the following output:
</para>
<screen>
<![CDATA[
PHP Warning: maxdb_connect(): -4008 POS(1) Unknown user name/password combination [08004] <...>
Can't connect to localhost. Errorcode: -4008
]]>
</screen>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_connect</function></member>
<member><function>maxdb_connect_error</function></member>
<member><function>maxdb_errno</function></member>
<member><function>maxdb_error</function></member>
<member><function>maxdb_sqlstate</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

41
reference/maxdb/functions/maxdb-connect-error.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-connect-error">
<refnamediv>
<refname>maxdb_connect_error</refname>
<refpurpose>Returns a string description of the last connect error</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>maxdb_connect_error</methodname>
<void />
@ -20,24 +21,16 @@
If no error has occured, this function will return an empty string.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A string that describes the error. An empty string if no error occurred.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_connect</function>,
<function>maxdb_connect_errno</function>,
<function>maxdb_errno</function>,
<function>maxdb_error</function>,
<function>maxdb_sqlstate</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>maxdb_connect_error sample</title>
@ -65,6 +58,20 @@ Can't connect to localhost. Error: POS(1) Unknown user name/password combination
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_connect</function></member>
<member><function>maxdb_connect_errno</function></member>
<member><function>maxdb_errno</function></member>
<member><function>maxdb_error</function></member>
<member><function>maxdb_sqlstate</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

18
reference/maxdb/functions/maxdb-connect.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-connect">
<refnamediv>
<refname>maxdb_connect</refname>
<refname>maxdb()</refname>
<refpurpose>Open a new connection to the MaxDB server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style</para>
<methodsynopsis>
<type>resource</type><methodname>maxdb_connect</methodname>
@ -54,15 +55,17 @@
ignored for the MaxDB server.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a resource which represents the connection to a MaxDB Server or
&false; if the connection failed.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -114,6 +117,7 @@ Host information: localhost
]]>
</screen>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

37
reference/maxdb/functions/maxdb-data-seek.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-data-seek">
<refnamediv>
<refname>maxdb_data_seek</refname>
<refname>result->data_seek</refname>
<refpurpose>Adjusts the result pointer to an arbitary row in the result</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_data_seek</methodname>
@ -30,22 +31,16 @@
zero and the total number of rows minus one (0..<function>maxdb_num_rows</function> - 1).
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_store_result</function>,
<function>maxdb_fetch_row</function>,
<function>maxdb_num_rows</function>.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -125,6 +120,18 @@ City: Irvine State: CA
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_store_result</function></member>
<member><function>maxdb_fetch_row</function></member>
<member><function>maxdb_num_rows</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

18
reference/maxdb/functions/maxdb-debug.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-debug">
<refnamediv>
<refname>maxdb_debug</refname>
<refpurpose>Performs debugging operations</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>maxdb_debug</methodname>
<methodparam><type>string</type><parameter>debug</parameter></methodparam>
@ -27,14 +28,16 @@
at least 8192 bytes are required.</member>
</simplelist>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>maxdb_debug</function> doesn't return any value.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Procedural style</title>
<programlisting role="php">
@ -61,6 +64,7 @@ maxdb_close($link);
The above example produces no output.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/maxdb/functions/maxdb-disable-reads-from-master.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-disable-reads-from-master">
<refnamediv>
<refname>maxdb_disable_reads_from_master</refname>
<refname>maxdb->disable_reads_from_master</refname>
<refpurpose>Disable reads from master</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_disable_reads_from_master</methodname>
@ -25,6 +26,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/maxdb/functions/maxdb-disable-rpl-parse.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.maxdb-disable-rpl-parse">
<refnamediv>
<refname>maxdb_disable_rpl_parse</refname>
<refpurpose>Disable RPL parse</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>maxdb_disable_rpl_parse</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
@ -15,6 +16,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/maxdb/functions/maxdb-dump-debug-info.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-dump-debug-info">
<refnamediv>
<refname>maxdb_dump_debug_info</refname>
<refpurpose>Dump debugging information into the log</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>maxdb_dump_debug_info</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
@ -15,6 +16,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/maxdb/functions/maxdb-embedded-connect.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-embedded-connect">
<refnamediv>
<refname>maxdb_embedded_connect</refname>
<refpurpose>Open a connection to an embedded MaxDB server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>maxdb_embedded_connect</methodname>
<methodparam choice="opt"><type>string</type><parameter>dbname</parameter></methodparam>
@ -15,6 +16,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/maxdb/functions/maxdb-enable-reads-from-master.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.maxdb-enable-reads-from-master">
<refnamediv>
<refname>maxdb_enable_reads_from_master</refname>
<refpurpose>Enable reads from master</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>maxdb_enable_reads_from_master</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
@ -15,6 +16,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/maxdb/functions/maxdb-enable-rpl-parse.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.maxdb-enable-rpl-parse">
<refnamediv>
<refname>maxdb_enable_rpl_parse</refname>
<refpurpose>Enable RPL parse</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>maxdb_enable_rpl_parse</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
@ -15,6 +16,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

39
reference/maxdb/functions/maxdb-errno.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-errno">
<refnamediv>
<refname>maxdb_errno</refname>
<refname>maxdb->errno</refname>
<refpurpose>Returns the error code for the most recent function call</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>maxdb_errno</methodname>
@ -25,23 +26,16 @@
have occured, this function will return zero.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An error code value for the last call, if it failed. zero means no error occurred.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_connect_errno</function>,
<function>maxdb_connect_error</function>,
<function>maxdb_error</function>,
<function>maxdb_sqlstate</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -98,6 +92,19 @@ Errorcode: -4005
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_connect_errno</function></member>
<member><function>maxdb_connect_error</function></member>
<member><function>maxdb_error</function></member>
<member><function>maxdb_sqlstate</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

39
reference/maxdb/functions/maxdb-error.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-error">
<refnamediv>
<refname>maxdb_error</refname>
<refpurpose>Returns a string description of the last error</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>maxdb_error</methodname>
@ -26,23 +27,16 @@
this function will return an empty string.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A string that describes the error. An empty string if no error occurred.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_connect_errno</function>,
<function>maxdb_connect_error</function>,
<function>maxdb_errno</function>,
<function>maxdb_sqlstate</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -99,6 +93,19 @@ Errormessgae: POS(8) Unknown column name:XXX
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_connect_errno</function></member>
<member><function>maxdb_connect_error</function></member>
<member><function>maxdb_errno</function></member>
<member><function>maxdb_sqlstate</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

3
reference/maxdb/functions/maxdb-escape-string.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-escape-string">
<refnamediv>
<refname>maxdb_escape_string</refname>
@ -13,6 +13,7 @@
<function>maxdb_real_escape_string</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

3
reference/maxdb/functions/maxdb-execute.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-execute">
<refnamediv>
<refname>maxdb_execute</refname>
@ -14,6 +14,7 @@
</simpara>
&info.function.alias.deprecated;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

37
reference/maxdb/functions/maxdb-fetch-array.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-fetch-array">
<refnamediv>
<refname>maxdb_fetch_array</refname>
<refname>result->fetch_array</refname>
<refpurpose>Fetch a result row as an associative, a numeric array, or both</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>maxdb_fetch_array</methodname>
@ -63,22 +64,16 @@
of MAXDB_ASSOC except the array index of a column is the fieldname in lower case.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array that corresponds to the fetched row or &null; if there are no more rows in resultset.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_fetch_assoc</function>,
<function>maxdb_fetch_row</function>,
<function>maxdb_fetch_resource</function>.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -164,6 +159,18 @@ Long Island (NY)
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_fetch_assoc</function></member>
<member><function>maxdb_fetch_row</function></member>
<member><function>maxdb_fetch_resource</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

37
reference/maxdb/functions/maxdb-fetch-assoc.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-fetch-assoc">
<refnamediv>
<refname>maxdb_fetch_assoc</refname>
<refname>maxdb->fetch_assoc</refname>
<refpurpose>Fetch a result row as an associative array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>array</type><methodname>maxdb_fetch_assoc</methodname>
@ -42,22 +43,16 @@
&database.field-case;
&database.fetch-null;
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array that corresponds to the fetched row or &null; if there are no more rows in resultset.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_fetch_array</function>,
<function>maxdb_fetch_row</function>,
<function>maxdb_fetch_resource</function>.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -155,6 +150,18 @@ Portland (OR)
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_fetch_array</function></member>
<member><function>maxdb_fetch_row</function></member>
<member><function>maxdb_fetch_resource</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

37
reference/maxdb/functions/maxdb-fetch-field-direct.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-fetch-field-direct">
<refnamediv>
<refname>maxdb_fetch_field_direct</refname>
<refname>result->fetch_field_direct</refname>
<refpurpose>Fetch meta-data for a single field</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>maxdb_fetch_field_direct</methodname>
@ -29,8 +30,9 @@
range from <literal>0</literal> to <literal>number of fields - 1</literal>.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an resource which contains field definition informations or &false; if no field information
for specified <literal>fieldnr</literal> is available.
@ -67,16 +69,9 @@
</table>
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_num_fields</function>
<function>maxdb_fetch_field</function>
<function>maxdb_fetch_fields</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -160,6 +155,18 @@ Type: 0
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_num_fields</function></member>
<member><function>maxdb_fetch_field</function></member>
<member><function>maxdb_fetch_fields</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

39
reference/maxdb/functions/maxdb-fetch-field.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-fetch-field">
<refnamediv>
<refname>maxdb_fetch_field</refname>
<refname>result->fetch_field</refname>
<refpurpose>Returns the next field in the result set</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>maxdb_fetch_field</methodname>
@ -29,8 +30,9 @@
are left.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an resource which contains field definition informations or &false; if no field information
is available.
@ -67,17 +69,9 @@
</table>
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_num_fields</function>
<function>maxdb_fetch_field_direct</function>
<function>maxdb_fetch_fields</function>
<function>maxdb_field_seek</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -167,6 +161,19 @@ Type: 0
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_num_fields</function></member>
<member><function>maxdb_fetch_field_direct</function></member>
<member><function>maxdb_fetch_fields</function></member>
<member><function>maxdb_field_seek</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

37
reference/maxdb/functions/maxdb-fetch-fields.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.maxdb-fetch-fields">
<refnamediv>
<refname>maxdb_fetch_fields</refname>
<refname>result->fetch_fields</refname>
<refpurpose>Returns an array of resources representing the fields in a result set</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural Style:</para>
<methodsynopsis>
<type>mixed</type><methodname>maxdb_fetch_fields</methodname>
@ -28,8 +29,9 @@
each field, the columns are returned as an array of resources.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of resources which contains field definition informations or &false; if no field information
is available.
@ -66,16 +68,9 @@
</table>
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_num_fields</function>
<function>maxdb_fetch_field</function>
<function>maxdb_fetch_field_direct</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -167,6 +162,18 @@ Type: 0
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_num_fields</function></member>
<member><function>maxdb_fetch_field</function></member>
<member><function>maxdb_fetch_field_direct</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

18
reference/maxdb/functions/maxdb-fetch-lengths.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.maxdb-fetch-lengths">
<refnamediv>
<refname>maxdb_fetch_lengths</refname>
<refname>result->lengths</refname>
<refpurpose>Returns the lengths of the columns of the current row in the result set</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>array</type><methodname>maxdb_fetch_lengths</methodname>
@ -25,8 +26,9 @@
representing the lengths of each column is returned or &false; on failure.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An array of integers representing the size of each column (not including
any terminating null characters). &false; if an error occurred.
@ -37,8 +39,9 @@
all rows in the result.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -117,6 +120,7 @@ Field 6 has Length 21
]]>
</screen>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

37
reference/maxdb/functions/maxdb-fetch-object.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.maxdb-fetch-object">
<refnamediv>
<refname>maxdb_fetch_object</refname>
<refname>result->fetch_object</refname>
<refpurpose>Returns the current row of a result set as an object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>object</type><methodname>maxdb_fetch_object</methodname>
@ -27,24 +28,18 @@
within the result set. If no more rows exist in the current result set, &null; is returned.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an object that corresponds to the fetched row or &null; if there are no more rows in resultset.
</para>
&database.field-case;
&database.fetch-null;
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_fetch_array</function>,
<function>maxdb_fetch_assoc</function>,
<function>maxdb_fetch_row</function>.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -142,6 +137,18 @@ Portland (OR)
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_fetch_array</function></member>
<member><function>maxdb_fetch_assoc</function></member>
<member><function>maxdb_fetch_row</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

37
reference/maxdb/functions/maxdb-fetch-row.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-fetch-row">
<refnamediv>
<refname>maxdb_fetch_row</refname>
<refname>result->fetch_row</refname>
<refpurpose>Get a result row as an enumerated array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>maxdb_fetch_row</methodname>
@ -33,24 +34,18 @@
or &false; if there are no more rows.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>maxdb_fetch_row</function> returns an array that corresponds to the fetched row
or &null; if there are no more rows in result set.
</para>
&database.fetch-null;
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_fetch_array</function>,
<function>maxdb_fetch_assoc</function>,
<function>maxdb_fetch_resource</function>.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -148,6 +143,18 @@ Portland (OR)
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_fetch_array</function></member>
<member><function>maxdb_fetch_assoc</function></member>
<member><function>maxdb_fetch_resource</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

3
reference/maxdb/functions/maxdb-fetch.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-fetch">
<refnamediv>
<refname>maxdb_fetch</refname>
@ -14,6 +14,7 @@
</simpara>
&info.function.alias.deprecated;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

22
reference/maxdb/functions/maxdb-field-count.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.maxdb-field-count">
<refnamediv>
<refname>maxdb_field_count</refname>
<refname>maxdb->field_count</refname>
<refpurpose>Returns the number of columns for the most recent query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>maxdb_field_count</methodname>
@ -30,12 +31,16 @@
set or not without knowing the nature of the query.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<para>An integer representing the number of fields in a result set</para>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An integer representing the number of fields in a result set.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Object oriented style</title>
@ -108,6 +113,7 @@ maxdb_close($link);
The above example produces no output.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/maxdb/functions/maxdb-field-seek.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.maxdb-field-seek">
<refnamediv>
<refname>maxdb_field_seek</refname>
<refname>result->field_seek</refname>
<refpurpose>Set result pointer to a specified field offset</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_field_seek</methodname>
@ -30,20 +31,16 @@
<para>To seek to the beginning of a row, pass an offset value of zero.</para>
</note>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>maxdb_field_seek</function> returns previuos value of field cursor.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_fetch_field</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -129,6 +126,16 @@ Type: 2
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_fetch_field</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/maxdb/functions/maxdb-field-tell.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-field-tell">
<refnamediv>
<refname>maxdb_field_tell</refname>
<refname>result->current_field</refname>
<refpurpose>Get current field offset of a result pointer</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>maxdb_field_tell</methodname>
@ -27,21 +28,16 @@
be used as an argument to <function>maxdb_field_seek</function>.
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns current offset of field cursor.
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>maxdb_fetch_field</function>,
<function>maxdb_field_seek</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -141,6 +137,17 @@ Type: 0
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_fetch_field</function></member>
<member><function>maxdb_field_seek</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

23
reference/maxdb/functions/maxdb-free-result.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-free-result">
<refnamediv>
<refname>maxdb_free_result</refname>
<refname>result->free</refname>
<refpurpose>Frees the memory associated with a result</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>void</type><methodname>maxdb_free_result</methodname>
@ -36,19 +37,23 @@
</para>
</note>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
This function doesn't return any value.
</para>
</refsect1>
<refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<function>maxdb_query</function>,
<function>maxdb_stmt_store_result</function>,
<function>maxdb_store_result</function>,
<function>maxdb_use_result</function>.
<simplelist>
<member><function>maxdb_query</function></member>
<member><function>maxdb_stmt_store_result</function></member>
<member><function>maxdb_store_result</function></member>
<member><function>maxdb_use_result</function></member>
</simplelist>
</para>
</refsect1>

35
reference/maxdb/functions/maxdb-get-client-info.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-get-client-info">
<refnamediv>
<refname>maxdb_get_client_info</refname>
<refpurpose>Returns the MaxDB client version as a string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>maxdb_get_client_info</methodname>
<void />
@ -17,22 +18,16 @@
MaxDB extension.
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A string that represents the MaxDB client library version
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_get_client_version</function>,
<function>maxdb_get_server_info</function>,
<function>maxdb_get_server_version</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>maxdb_get_client_info</title>
@ -58,6 +53,18 @@ Client library version: libSQLDBC <...>
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_get_client_version</function></member>
<member><function>maxdb_get_server_info</function></member>
<member><function>maxdb_get_server_version</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

37
reference/maxdb/functions/maxdb-get-client-version.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-get-client-version">
<refnamediv>
<refname>maxdb_get_client_version</refname>
<refpurpose>Get MaxDB client info</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>maxdb_get_client_version</methodname>
<void/>
@ -15,8 +16,9 @@
Returns client version number as an integer.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A number that represents the MaxDB client library version in format:
<literal>main_version*10000 + minor_version *100 + sub_version</literal>.
@ -27,16 +29,9 @@
to know if some capability exists.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_get_client_info</function>,
<function>maxdb_get_server_info</function>,
<function>maxdb_get_server_version</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>maxdb_get_client_version</title>
@ -62,6 +57,18 @@ Client library version: 7.<...>
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_get_client_info</function></member>
<member><function>maxdb_get_server_info</function></member>
<member><function>maxdb_get_server_version</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

31
reference/maxdb/functions/maxdb-get-host-info.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-get-host-info">
<refnamediv>
<refname>maxdb_get_host_info</refname>
<refname>maxdb->get_host_info</refname>
<refpurpose>Returns a string representing the type of connection used</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procdural style:</para>
<methodsynopsis>
<type>string</type><methodname>maxdb_get_host_info</methodname>
@ -24,20 +25,16 @@
parameter is using.
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A character string representing the server hostname and the connection type.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_get_proto_info</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -91,6 +88,16 @@ Host info: localhost
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_get_proto_info</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

3
reference/maxdb/functions/maxdb-get-metadata.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-get-metadata">
<refnamediv>
<refname>maxdb_get_metadata</refname>
@ -14,6 +14,7 @@
</simpara>
&info.function.alias.deprecated;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

31
reference/maxdb/functions/maxdb-get-proto-info.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-get-proto-info">
<refnamediv>
<refname>maxdb_get_proto_info</refname>
<refname>maxdb->protocol_version</refname>
<refpurpose>Returns the version of the MaxDB protocol used</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>maxdb_get_proto_info</methodname>
@ -23,20 +24,16 @@
connection represented by the <parameter>link</parameter> parameter.
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an integer representing the protocol version (constant 10).
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_get_host_info</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -90,6 +87,16 @@ Protocol version: 10
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_get_host_info</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/maxdb/functions/maxdb-get-server-info.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-get-server-info">
<refnamediv>
<refname>maxdb_get_server_info</refname>
<refname>maxdb->server_info</refname>
<refpurpose>Returns the version of the MaxDB server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>maxdb_get_server_info</methodname>
@ -24,22 +25,16 @@
<parameter>link</parameter> parameter).
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A character string representing the server version.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_get_client_info</function>,
<function>maxdb_get_client_version</function>,
<function>maxdb_get_server_version</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -93,6 +88,18 @@ Server version: Kernel 7<...>
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_get_client_info</function></member>
<member><function>maxdb_get_client_version</function></member>
<member><function>maxdb_get_server_version</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/maxdb/functions/maxdb-get-server-version.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-get-server-version">
<refnamediv>
<refname>maxdb_get_server_version</refname>
<refpurpose>Returns the version of the MaxDB server as an integer</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>maxdb_get_server_version</methodname>
@ -28,22 +29,16 @@
(i.e. version 7.5.0 is 70500).
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An integer representing the server version.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_get_client_info</function>,
<function>maxdb_get_client_version</function>,
<function>maxdb_get_server_info</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -97,6 +92,18 @@ Server version: 7<...>
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_get_client_info</function></member>
<member><function>maxdb_get_client_version</function></member>
<member><function>maxdb_get_server_info</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/maxdb/functions/maxdb-info.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-info">
<refnamediv>
<refname>maxdb_info</refname>
<refname>maxdb->info</refname>
<refpurpose>Retrieves information about the most recently executed query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>maxdb_info</methodname>
@ -65,22 +66,16 @@
</para>
</note>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A character string representing additional information about the most recently executed query.
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>maxdb_affected_rows</function>,
<function>maxdb_warning_count</function>,
<function>maxdb_num_rows</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -140,6 +135,18 @@ Records: 25 Duplicates: 0 Warnings: 0
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_affected_rows</function></member>
<member><function>maxdb_warning_count</function></member>
<member><function>maxdb_num_rows</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

24
reference/maxdb/functions/maxdb-init.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-init">
<refnamediv>
<refname>maxdb_init</refname>
<refpurpose>Initializes MaxDB and returns an resource for use with maxdb_real_connect</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>maxdb_init</methodname>
<void/>
@ -22,21 +23,26 @@
</para>
</note>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an resource.
</para>
</refsect1>
<refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<function>maxdb_options</function>,
<function>maxdb_close</function>,
<function>maxdb_real_connect</function>,
<function>maxdb_connect</function>
<simplelist>
<member><function>maxdb_options</function></member>
<member><function>maxdb_close</function></member>
<member><function>maxdb_real_connect</function></member>
<member><function>maxdb_connect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

16
reference/maxdb/functions/maxdb-insert-id.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-insert-id">
<refnamediv>
<refname>maxdb_insert_id</refname>
<refname>maxdb->insert_id</refname>
<refpurpose>Returns the auto generated id used in the last query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>maxdb_insert_id</methodname>
@ -26,7 +27,8 @@
return zero.
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The value of the <literal>DEFAULT SERIAL</literal> field that was updated
@ -41,8 +43,9 @@
</para>
</note>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -120,6 +123,7 @@ New Record has id 1.
]]>
</screen>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

31
reference/maxdb/functions/maxdb-kill.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-kill">
<refnamediv>
<refname>maxdb_kill</refname>
<refname>maxdb->kill</refname>
<refpurpose>Disconnects from a MaxDB server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_kill</methodname>
@ -28,20 +29,16 @@
by the <parameter>processid</parameter> parameter.
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>maxdb_thread_id</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -113,6 +110,16 @@ Error: Session not connected
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_thread_id</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/maxdb/functions/maxdb-master-query.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-master-query">
<refnamediv>
<refname>maxdb_master_query</refname>
<refpurpose>Enforce execution of a query on the master in a master/slave setup</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>maxdb_master_query</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
@ -16,6 +17,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

39
reference/maxdb/functions/maxdb-more-results.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-more-results">
<refnamediv>
<refname>maxdb_more_results</refname>
<refname>maxdb->more_results</refname>
<refpurpose>Check if there any more query results from a multi query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>maxdb_more_results</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
@ -17,25 +18,33 @@
are available from a previous call to <function>maxdb_multi_query</function>.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<para>Always &false;.</para>
</refsect1>
<refsect1>
<title>See also</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>maxdb_multi_query</function>,
<function>maxdb_next_result</function>,
<function>maxdb_store_result</function>,
<function>maxdb_use_result</function>
Always &false;.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<para>
See <function>maxdb_multi_query</function>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_multi_query</function></member>
<member><function>maxdb_next_result</function></member>
<member><function>maxdb_store_result</function></member>
<member><function>maxdb_use_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

39
reference/maxdb/functions/maxdb-multi-query.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.maxdb-multi-query">
<refnamediv>
<refname>maxdb_multi_query</refname>
<refname>maxdb->multi_query</refname>
<refpurpose>Performs a query on the database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_multi_query</methodname>
@ -28,23 +29,16 @@
<function>maxdb_query</function>. Multiple queries are not yet supported.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_use_result</function>,
<function>maxdb_store_result</function>,
<function>maxdb_next_result</function>,
<function>maxdb_more_results</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -130,6 +124,19 @@ a
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_use_result</function></member>
<member><function>maxdb_store_result</function></member>
<member><function>maxdb_next_result</function></member>
<member><function>maxdb_more_results</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

34
reference/maxdb/functions/maxdb-next-result.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-next-result">
<refnamediv>
<refname>maxdb_next_result</refname>
<refname>maxdb->next_result</refname>
<refpurpose>Prepare next result from multi_query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>maxdb_next_result</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
@ -17,19 +18,26 @@
returns always &false;.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<para>&false;</para>
</refsect1>
<refsect1>
<title>See also</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>maxdb_multi_query</function>,
<function>maxdb_more_results</function>,
<function>maxdb_store_result</function>,
<function>maxdb_use_result</function>
Returns &false;.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_multi_query</function></member>
<member><function>maxdb_more_results</function></member>
<member><function>maxdb_store_result</function></member>
<member><function>maxdb_use_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

31
reference/maxdb/functions/maxdb-num-fields.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-num-fields">
<refnamediv>
<refname>maxdb_num_fields</refname>
<refname>result->field_count</refname>
<refpurpose>Get the number of fields in a result</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>maxdb_num_fields</methodname>
@ -22,18 +23,14 @@
<function>maxdb_num_fields</function> returns the number of fields from specified result set.
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>The number of fields from a result set</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>maxdb_fetch_field</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -103,6 +100,16 @@ Result set has 3 fields.
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_fetch_field</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

37
reference/maxdb/functions/maxdb-num-rows.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-num-rows">
<refnamediv>
<refname>maxdb_num_rows</refname>
<refpurpose>Gets the number of rows in a result</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>maxdb_num_rows</methodname>
@ -28,7 +29,8 @@
have been retrieved.
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns number of rows in the result set.
@ -40,17 +42,9 @@
</para>
</note>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>maxdb_affected_rows</function>
<function>maxdb_store_result</function>
<function>maxdb_use_result</function>
<function>maxdb_query</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -120,6 +114,19 @@ Result set has 15 rows.
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_affected_rows</function></member>
<member><function>maxdb_store_result</function></member>
<member><function>maxdb_use_result</function></member>
<member><function>maxdb_query</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

31
reference/maxdb/functions/maxdb-options.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-options">
<refnamediv>
<refname>maxdb_options</refname>
<refname>maxdb->options</refname>
<refpurpose>Set options</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_options</methodname>
@ -112,23 +113,31 @@
</table>
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<refsect1 role="examples">
&reftitle.examples;
<para>
<function>maxdb_init</function>,
<function>maxdb_real_connect</function>
See <function>maxdb_real_connect</function>.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<para>See <function>maxdb_real_connect</function>.</para>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_init</function></member>
<member><function>maxdb_real_connect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

3
reference/maxdb/functions/maxdb-param-count.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-param-count">
<refnamediv>
<refname>maxdb_param_count</refname>
@ -14,6 +14,7 @@
</simpara>
&info.function.alias.deprecated;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

18
reference/maxdb/functions/maxdb-ping.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-ping">
<refnamediv>
<refname>maxdb_ping</refname>
<refname>maxdb->ping</refname>
<refpurpose>Pings a server connection, or tries to reconnect if the connection has gone down</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_ping</methodname>
@ -32,14 +33,16 @@
necessary.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -101,6 +104,7 @@ Our connection is ok!
]]>
</screen>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

39
reference/maxdb/functions/maxdb-prepare.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-prepare">
<refnamediv>
<refname>maxdb_prepare</refname>
<refname>maxdb->prepare</refname>
<refpurpose>Prepare a SQL statement for execution</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedure style:</para>
<methodsynopsis>
<type>resource</type><methodname>maxdb_prepare</methodname>
@ -61,24 +62,16 @@
before executing the statement or fetching rows.
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>maxdb_prepare</function> returns a statement resource or &false; if an error occured.
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>maxdb_stmt_execute</function>,
<function>maxdb_stmt_fetch</function>,
<function>maxdb_stmt_bind_param</function>,
<function>maxdb_stmt_bind_result</function>,
<function>maxdb_stmt_close</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -172,6 +165,20 @@ Rosemont is in district IL
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_stmt_execute</function></member>
<member><function>maxdb_stmt_fetch</function></member>
<member><function>maxdb_stmt_bind_param</function></member>
<member><function>maxdb_stmt_bind_result</function></member>
<member><function>maxdb_stmt_close</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

37
reference/maxdb/functions/maxdb-query.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-query">
<refnamediv>
<refname>maxdb_query</refname>
<refname>maxdb->query</refname>
<refpurpose>Performs a query on the database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>maxdb_query</methodname>
@ -30,24 +31,18 @@
<parameter>link</parameter> parameter.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success; For <literal>SELECT, SHOW, DESCRIBE</literal> or
<literal>EXPLAIN</literal> <function>maxdb_query</function> will return
a result resource.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_real_query</function>,
<function>maxdb_multi_query</function>,
<function>maxdb_free_result</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -130,6 +125,18 @@ Select returned 25 rows.
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_real_query</function></member>
<member><function>maxdb_multi_query</function></member>
<member><function>maxdb_free_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

39
reference/maxdb/functions/maxdb-real-connect.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-real-connect">
<refnamediv>
<refname>maxdb_real_connect</refname>
<refname>maxdb->real_connect</refname>
<refpurpose>Opens a connection to a MaxDB server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_real_connect</methodname>
@ -55,24 +56,16 @@
</listitem>
</itemizedlist>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>maxdb_connect</function>,
<function>maxdb_init</function>,
<function>maxdb_options</function>,
<function>maxdb_ssl_set</function>,
<function>maxdb_close</function>.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -140,6 +133,20 @@ Connection: localhost <...>
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_connect</function></member>
<member><function>maxdb_init</function></member>
<member><function>maxdb_options</function></member>
<member><function>maxdb_ssl_set</function></member>
<member><function>maxdb_close</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/maxdb/functions/maxdb-real-escape-string.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-real-escape-string">
<refnamediv>
<refname>maxdb_real_escape_string</refname>
<refname>maxdb->real_escape_string</refname>
<refpurpose>Escapes special characters in a string for use in a SQL statement, taking into account the current charset of the connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>maxdb_real_escape_string</methodname>
@ -32,20 +33,16 @@
Characters encoded are <literal>', "</literal>.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an escaped string.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_character_set_name</function>.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -125,6 +122,16 @@ Error: 42000
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_character_set_name</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

26
reference/maxdb/functions/maxdb-real-query.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-real-query">
<refnamediv>
<refname>maxdb_real_query</refname>
<refname>maxdb->real_query</refname>
<refpurpose>Execute an SQL query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_real_query</methodname>
@ -34,20 +35,25 @@
</para>
</note>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>See also</title>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<function>maxdb_query</function>
<function>maxdb_store_result</function>
<function>maxdb_use_result</function>
<simplelist>
<member><function>maxdb_query</function></member>
<member><function>maxdb_store_result</function></member>
<member><function>maxdb_use_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

13
reference/maxdb/functions/maxdb-report.xml
View file

@ -1,19 +1,21 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-report">
<refnamediv>
<refname>maxdb_report</refname>
<refpurpose>Enables or disables internal report functions</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>maxdb_report</methodname>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Procedural style</title>
<programlisting role="php">
@ -47,6 +49,7 @@ Warning: maxdb_query(): -4004 POS(18) Unknown table name:NONEXISTINGTABLE <...>
]]>
</screen>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/maxdb/functions/maxdb-rollback.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-rollback">
<refnamediv>
<refname>maxdb_rollback</refname>
<refname>maxdb->rollback</refname>
<refpurpose>Rolls back current transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>maxdb_rollback</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
@ -25,21 +26,16 @@
<parameter>link</parameter> parameter.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_commit</function>
<function>maxdb_autocommit</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -150,6 +146,17 @@ maxdb_close($link);
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_commit</function></member>
<member><function>maxdb_autocommit</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/maxdb/functions/maxdb-rpl-parse-enabled.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-rpl-parse-enabled">
<refnamediv>
<refname>maxdb_rpl_parse_enabled</refname>
<refpurpose>Check if RPL parse is enabled</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>maxdb_rpl_parse_enabled</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
@ -15,6 +16,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/maxdb/functions/maxdb-rpl-probe.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-rpl-probe">
<refnamediv>
<refname>maxdb_rpl_probe</refname>
<refpurpose>RPL probe</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>maxdb_rpl_probe</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
@ -15,6 +16,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/maxdb/functions/maxdb-rpl-query-type.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.maxdb-rpl-query-type">
<refnamediv>
<refname>maxdb_rpl_query_type</refname>
<refname>maxdb->rpl_query_type</refname>
<refpurpose>Returns RPL query type</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>maxdb_rpl_query_type</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
@ -24,6 +25,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/maxdb/functions/maxdb-select-db.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-select-db">
<refnamediv>
<refname>maxdb_select_db</refname>
<refname>maxdb->select_db</refname>
<refpurpose>Selects the default database for database queries</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>maxdb_select_db</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
@ -26,21 +27,16 @@
</para>
</note>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_connect</function>
<function>maxdb_real_connect</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -126,6 +122,17 @@ Warning: maxdb_close(): -10821 Session not connected [] <...>
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_connect</function></member>
<member><function>maxdb_real_connect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

3
reference/maxdb/functions/maxdb-send-long-data.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-send-long-data">
<refnamediv>
<refname>maxdb_send_long_data</refname>
@ -14,6 +14,7 @@
</simpara>
&info.function.alias.deprecated;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/maxdb/functions/maxdb-send-query.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-send-query">
<refnamediv>
<refname>maxdb_send_query</refname>
<refname>maxdb->send_query</refname>
<refpurpose>Send the query and return</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>maxdb_send_query</methodname>
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
@ -25,6 +26,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/maxdb/functions/maxdb-server-end.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-server-end">
<refnamediv>
<refname>maxdb_server_end</refname>
<refpurpose>Shut down the embedded server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>maxdb_server_end</methodname>
<void/>
@ -15,6 +16,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/maxdb/functions/maxdb-server-init.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-server-init">
<refnamediv>
<refname>maxdb_server_init</refname>
<refpurpose>Initialize embedded server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>maxdb_server_init</methodname>
<methodparam choice="opt"><type>array</type><parameter>server</parameter></methodparam>
@ -16,6 +17,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

3
reference/maxdb/functions/maxdb-set-opt.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-set-opt">
<refnamediv>
<refname>maxdb_set_opt</refname>
@ -13,6 +13,7 @@
<function>maxdb_options</function>.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/maxdb/functions/maxdb-sqlstate.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-sqlstate">
<refnamediv>
<refname>maxdb_sqlstate</refname>
<refname>maxdb->sqlstate</refname>
<refpurpose>Returns the SQLSTATE error from previous MaxDB operation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>maxdb_sqlstate</methodname>
@ -30,22 +31,17 @@
</para>
</note>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a string containing the SQLSTATE error code for the last error.
The error code consists of five characters. <literal>'00000'</literal> means no error.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_errno</function>,
<function>maxdb_error</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -102,6 +98,17 @@ Error - SQLSTATE I6000.
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_errno</function></member>
<member><function>maxdb_error</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/maxdb/functions/maxdb-ssl-set.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.maxdb-ssl-set">
<refnamediv>
<refname>maxdb_ssl_set</refname>
<refname>maxdb->ssl_set</refname>
<refpurpose>Used for establishing secure connections using SSL</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_ssl_set</methodname>
@ -34,6 +35,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/maxdb/functions/maxdb-stat.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-stat">
<refnamediv>
<refname>maxdb_stat</refname>
<refname>maxdb->stat</refname>
<refpurpose>Gets the current system status</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>maxdb_stat</methodname>
@ -26,20 +27,16 @@
information about the MaxDB server running.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A string describing the server status. &false; if an error occurred.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_get_server_info</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -89,6 +86,16 @@ System status: Kernel 7<...>
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_get_server_info</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/maxdb/functions/maxdb-stmt-affected-rows.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-stmt-affected-rows">
<refnamediv>
<refname>maxdb_stmt_affected_rows</refname>
@ -8,8 +8,9 @@
inserted by the last executed statement
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style :</para>
<methodsynopsis>
<type>int</type><methodname>maxdb_stmt_affected_rows</methodname>
@ -26,8 +27,9 @@
number of rows can not determined, this function will return -1.
</para>
</refsect1>
<refsect1>
<title>Return Values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An integer greater than zero indicates the number of rows affected or retrieved.
Zero indicates that no records where updated for an UPDATE/DELETE statement, no
@ -35,15 +37,9 @@
-1 indicates that the query has returned an error or the number of rows can not determined.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_stmt_num_rows</function>,
<function>maxdb_prepare</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -133,6 +129,17 @@ rows inserted: 4
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_stmt_num_rows</function></member>
<member><function>maxdb_prepare</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

45
reference/maxdb/functions/maxdb-stmt-bind-param.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.maxdb-stmt-bind-param">
<refnamediv>
<refname>maxdb_stmt_bind_param</refname>
<refname>stmt->bind_param</refname>
<refpurpose>Binds variables to a prepared statement as parameters</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt_bind_param</methodname>
@ -104,26 +105,16 @@
</table>
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_stmt_bind_result</function>,
<function>maxdb_stmt_execute</function>,
<function>maxdb_stmt_fetch</function>,
<function>maxdb_prepare</function>,
<function>maxdb_stmt_send_long_data</function>,
<function>maxdb_stmt_errno</function>,
<function>maxdb_stmt_error</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -374,6 +365,22 @@ $maxdb->close();
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_stmt_bind_result</function></member>
<member><function>maxdb_stmt_execute</function></member>
<member><function>maxdb_stmt_fetch</function></member>
<member><function>maxdb_prepare</function></member>
<member><function>maxdb_stmt_send_long_data</function></member>
<member><function>maxdb_stmt_errno</function></member>
<member><function>maxdb_stmt_error</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

47
reference/maxdb/functions/maxdb-stmt-bind-result.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.maxdb-stmt-bind-result">
<refnamediv>
<refname>maxdb_stmt_bind_result</refname>
<refname>stmt->bind_result</refname>
<refpurpose>Binds variables to a prepared statement for result storage</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt_bind_result</methodname>
@ -42,27 +43,16 @@
</para>
</note>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_stmt_bind_param</function>,
<function>maxdb_stmt_execute</function>,
<function>maxdb_stmt_fetch</function>,
<function>maxdb_prepare</function>,
<function>maxdb_stmt_prepare</function>,
<function>maxdb_stmt_init</function>,
<function>maxdb_stmt_errno</function>,
<function>maxdb_stmt_error</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -165,6 +155,23 @@ maxdb_close($link);
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_stmt_bind_param</function></member>
<member><function>maxdb_stmt_execute</function></member>
<member><function>maxdb_stmt_fetch</function></member>
<member><function>maxdb_prepare</function></member>
<member><function>maxdb_stmt_prepare</function></member>
<member><function>maxdb_stmt_init</function></member>
<member><function>maxdb_stmt_errno</function></member>
<member><function>maxdb_stmt_error</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

20
reference/maxdb/functions/maxdb-stmt-close-long-data.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.maxdb-stmt-close-long-data">
<refnamediv>
<refname>maxdb_stmt_close_long_data</refname>
<refname>stmt->close_long_data</refname>
<refpurpose>Ends a sequence of <function>maxdb_stmt_send_long_data</function></refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt_close_long_data</methodname>
@ -33,19 +34,24 @@
Parameters are numbered beginning with 0.
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<function>maxdb_prepare</function>,
<function>maxdb_stmt_bind_param</function>
<simplelist>
<member><function>maxdb_prepare</function></member>
<member><function>maxdb_stmt_bind_param</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

22
reference/maxdb/functions/maxdb-stmt-close.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-stmt-close">
<refnamediv>
<refname>maxdb_stmt_close</refname>
<refname>maxdb_stmt->close</refname>
<refpurpose>Closes a prepared statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt_close</methodname>
@ -28,18 +29,23 @@
the next query can be executed.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>See also</title>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<function>maxdb_prepare</function>,
<simplelist>
<member><function>maxdb_prepare</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/maxdb/functions/maxdb-stmt-data-seek.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-stmt-data-seek">
<refnamediv>
<refname>maxdb_stmt_data_seek</refname>
<refname>stmt->data_seek</refname>
<refpurpose>Seeks to an arbitray row in statement result set</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt_data_seek</methodname>
@ -30,20 +31,16 @@
zero and the total number of rows minus one (0..<function>maxdb_stmt_num_rows</function> - 1).
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_prepare</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -141,6 +138,16 @@ City: Dallas Zip: 75243
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_prepare</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

39
reference/maxdb/functions/maxdb-stmt-errno.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-stmt-errno">
<refnamediv>
<refname>maxdb_stmt_errno</refname>
<refname>maxdb_stmt->errno</refname>
<refpurpose>Returns the error code for the most recent statement call</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style :</para>
<methodsynopsis>
<type>int</type><methodname>maxdb_stmt_errno</methodname>
@ -29,21 +30,26 @@
</para>
</note>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An error code value. Zero means no error occurred.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<function>maxdb_stmt_error</function>,
<function>maxdb_stmt_sqlstate</function>
<simplelist>
<member><function>maxdb_stmt_error</function></member>
<member><function>maxdb_stmt_sqlstate</function></member>
</simplelist>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -132,6 +138,17 @@ Error: -4004.
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_stmt_error</function></member>
<member><function>maxdb_stmt_sqlstate</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/maxdb/functions/maxdb-stmt-error.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-stmt-error">
<refnamediv>
<refname>maxdb_stmt_error</refname>
<refname>maxdb_stmt->error</refname>
<refpurpose>Returns a string description for last statement error</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>maxdb_stmt_error</methodname>
@ -24,21 +25,16 @@
can succeed or fail.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A string that describes the error. An empty string if no error occurred.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_stmt_errno</function>,
<function>maxdb_stmt_sqlstate</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -127,6 +123,17 @@ Error: POS(23) Unknown table name:MYCITY.
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_stmt_errno</function></member>
<member><function>maxdb_stmt_sqlstate</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/maxdb/functions/maxdb-stmt-execute.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-stmt-execute">
<refnamediv>
<refname>maxdb_stmt_execute</refname>
<refname>stmt->execute</refname>
<refpurpose>Executes a prepared Query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt_execute</methodname>
@ -40,21 +41,16 @@
</para>
</note>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_prepare</function>
<function>maxdb_stmt_bind_param</function>.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -179,6 +175,17 @@ maxdb_close($link);
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_prepare</function></member>
<member><function>maxdb_stmt_bind_param</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

39
reference/maxdb/functions/maxdb-stmt-fetch.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-stmt-fetch">
<refnamediv>
<refname>maxdb_stmt_fetch</refname>
<refname>stmt->fetch</refname>
<refpurpose>Fetch results from a prepared statement into the bound variables</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt_fetch</methodname>
@ -31,8 +32,9 @@
</para>
</note>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<table>
<title>Return values</title>
<tgroup cols='2'>
@ -59,17 +61,9 @@
</tgroup>
</table>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_prepare</function>,
<function>maxdb_stmt_errno</function>,
<function>maxdb_stmt_error</function>,
<function>maxdb_stmt_bind_result</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -179,6 +173,19 @@ maxdb_close($link);
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_prepare</function></member>
<member><function>maxdb_stmt_errno</function></member>
<member><function>maxdb_stmt_error</function></member>
<member><function>maxdb_stmt_bind_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

17
reference/maxdb/functions/maxdb-stmt-free-result.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-stmt-free-result">
<refnamediv>
<refname>maxdb_stmt_free_result</refname>
<refname>stmt->free_result</refname>
<refpurpose>Frees stored result memory for the given statement handle</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>void</type><methodname>maxdb_stmt_free_result</methodname>
@ -29,16 +30,20 @@
<function>maxdb_stmt_store_result</function>.
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
This function doesn't return any value.
</para>
</refsect1>
<refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<function>maxdb_stmt_store_result</function>
<simplelist>
<member><function>maxdb_stmt_store_result</function></member>
</simplelist>
</para>
</refsect1>

18
reference/maxdb/functions/maxdb-stmt-init.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-stmt-init">
<refnamediv>
<refname>maxdb_stmt_init</refname>
<refname>maxdb->stmt_init</refname>
<refpurpose>Initializes a statement and returns an resource for use with maxdb_stmt_prepare</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style :</para>
<methodsynopsis>
<type>resource</type><methodname>maxdb_stmt_init</methodname>
@ -32,18 +33,23 @@
</para>
</note>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an resource.
</para>
</refsect1>
<refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<function>maxdb_stmt_prepare</function>
<simplelist>
<member><function>maxdb_stmt_prepare</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

37
reference/maxdb/functions/maxdb-stmt-num-rows.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-stmt-num-rows">
<refnamediv>
<refname>maxdb_stmt_num_rows</refname>
<refname>stmt->num_rows</refname>
<refpurpose>Return the number of rows in statements result set</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style :</para>
<methodsynopsis>
<type>int</type><methodname>maxdb_stmt_num_rows</methodname>
@ -22,22 +23,16 @@
Returns the number of rows in the result set.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An integer representing the number of rows in result set.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_stmt_affected_rows</function>,
<function>maxdb_prepare</function>,
<function>maxdb_stmt_store_result</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -117,6 +112,18 @@ Number of rows: 25.
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_stmt_affected_rows</function></member>
<member><function>maxdb_prepare</function></member>
<member><function>maxdb_stmt_store_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

31
reference/maxdb/functions/maxdb-stmt-param-count.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-stmt-param-count">
<refnamediv>
<refname>maxdb_stmt_param_count</refname>
<refname>stmt->param_count</refname>
<refpurpose>Returns the number of parameter for the given statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>maxdb_stmt_param_count</methodname>
@ -23,20 +24,16 @@
markers present in the prepared statement.
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
returns an integer representing the number of parameters.
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>maxdb_prepare</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -102,6 +99,16 @@ Statement has 2 markers.
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_prepare</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

41
reference/maxdb/functions/maxdb-stmt-prepare.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-stmt-prepare">
<refnamediv>
<refname>maxdb_stmt_prepare</refname>
<refname>stmt->prepare</refname>
<refpurpose>Prepare a SQL statement for execution</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedure style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt_prepare</methodname>
@ -63,25 +64,16 @@
before executing the statement or fetching rows.
</para>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>maxdb_stmt_init</function>,
<function>maxdb_stmt_execute</function>,
<function>maxdb_stmt_fetch</function>,
<function>maxdb_stmt_bind_param</function>,
<function>maxdb_stmt_bind_result</function>,
<function>maxdb_stmt_close</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -177,6 +169,21 @@ Portland is in district OR
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_stmt_init</function></member>
<member><function>maxdb_stmt_execute</function></member>
<member><function>maxdb_stmt_fetch</function></member>
<member><function>maxdb_stmt_bind_param</function></member>
<member><function>maxdb_stmt_bind_result</function></member>
<member><function>maxdb_stmt_close</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

8
reference/maxdb/functions/maxdb-stmt-reset.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-stmt-reset">
<refnamediv>
<refname>maxdb_stmt_reset</refname>
<refname>stmt->reset</refname>
<refpurpose>Resets a prepared statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt_reset</methodname>
@ -25,6 +26,7 @@
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/maxdb/functions/maxdb-stmt-result-metadata.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.maxdb-stmt-result-metadata">
<refnamediv>
<refname>maxdb_stmt_result_metadata</refname>
<refpurpose>Returns result set metadata from a prepared statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>resource</type><methodname>maxdb_stmt_result_metadata</methodname>
@ -53,22 +54,17 @@
</para>
</note>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>maxdb_stmt_result_metadata</function> returns a result resource or &false; if
an error occured.
</para>
</refsect1>
<refsect1>
<title>See also:</title>
<para>
<function>maxdb_prepare</function>,
<function>maxdb_free_result</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Object oriented style</title>
@ -144,6 +140,17 @@ Fieldname: ID
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_prepare</function></member>
<member><function>maxdb_free_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

20
reference/maxdb/functions/maxdb-stmt-send-long-data.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.maxdb-stmt-send-long-data">
<refnamediv>
<refname>maxdb_stmt_send_long_data</refname>
<refname>stmt->send_long_data</refname>
<refpurpose>Send data in blocks</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt_send_long_data</methodname>
@ -43,19 +44,24 @@
</para>
</note>
</refsect1>
<refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<function>maxdb_prepare</function>,
<function>maxdb_stmt_bind_param</function>
<simplelist>
<member><function>maxdb_prepare</function></member>
<member><function>maxdb_stmt_bind_param</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/maxdb/functions/maxdb-stmt-sqlstate.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-stmt-sqlstate">
<refnamediv>
<refname>maxdb_stmt_sqlstate</refname>
<refpurpose>Returns SQLSTATE error from previous statement operation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>maxdb_stmt_sqlstate</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
@ -24,22 +25,17 @@
</para>
</note>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a string containing the SQLSTATE error code for the last error.
The error code consists of five characters. <literal>'00000'</literal> means no error.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_stmt_errno</function>,
<function>maxdb_stmt_error</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -126,6 +122,17 @@ Error: 42000.
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_stmt_errno</function></member>
<member><function>maxdb_stmt_error</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

37
reference/maxdb/functions/maxdb-stmt-store-result.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-stmt-store-result">
<refnamediv>
<refname>maxdb_stmt_store_result</refname>
<refname>maxdb->store_result</refname>
<refpurpose>Transfers a result set from a prepared statement</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_stmt_store_result</methodname>
@ -27,22 +28,16 @@
and should not be used for retrieving data from MaxDB server.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_prepare</function>,
<function>maxdb_stmt_result_metadata</function>,
<function>maxdb_fetch</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -128,6 +123,18 @@ Number of rows: 25.
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_prepare</function></member>
<member><function>maxdb_stmt_result_metadata</function></member>
<member><function>maxdb_fetch</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/maxdb/functions/maxdb-store-result.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-store-result">
<refnamediv>
<refname>maxdb_store_result</refname>
<refname>maxdb->store_result</refname>
<refpurpose>Transfers a result set from the last query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>resource</type><methodname>maxdb_store_result</methodname>
@ -26,25 +27,31 @@
This function has no functionally effect.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a result resource or &false; if an error occurred.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_real_query</function>,
<function>maxdb_use_result</function>.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<para>
See <function>maxdb_multi_query</function>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_real_query</function></member>
<member><function>maxdb_use_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/maxdb/functions/maxdb-thread-id.xml
View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-thread-id">
<refnamediv>
<refname>maxdb_thread_id</refname>
<refname>maxdb->thread_id</refname>
<refpurpose>Returns the thread ID for the current connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>maxdb_thread_id</methodname>
@ -33,20 +34,16 @@
</para>
</note>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>maxdb_thread_id</function> returns the Thread ID for the current connection.
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<function>maxdb_kill</function>
</para>
</refsect1>
<refsect1>
<title>Example</title>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
@ -119,6 +116,16 @@ Error: Session not connected
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_kill</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

13
reference/maxdb/functions/maxdb-thread-safe.xml
View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.maxdb-thread-safe">
<refnamediv>
<refname>maxdb_thread_safe</refname>
<refpurpose>Returns whether thread safety is given or not</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>maxdb_thread_safe</methodname>
@ -17,12 +18,14 @@
client library is compiled as thread-safe.
</para>
</refsect1>
<refsect1>
<title>Return values</title>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&true; if the client library is thread-safe, otherwise &false;.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

Some files were not shown because too many files have changed in this diff Show more