cvs: phpdoc /en/reference/maxdb/functions maxdb-affected-rows.xml maxdb-autocommit.xml maxdb-change-user.xml maxdb-character-set-name.xml
maxdb-close.xml maxdb-commit.xml maxdb-connect-errno.xml maxdb-connect-error.xml maxdb-connect.xml maxdb-data-seek.xml maxdb-debug.xml
maxdb-disable-reads-from-master.xml maxdb-disable-rpl-parse.xml maxdb-dump-debug-info.xml maxdb-embedded-connect.xml
maxdb-enable-reads-from-master.xml maxdb-enable-rpl-parse.xml maxdb-errno.xml maxdb-error.xml maxdb-fetch-array.xml maxdb-fetch-assoc.xml
maxdb-fetch-field-direct.xml maxdb-fetch-field.xml maxdb-fetch-fields.xml maxdb-fetch-lengths.xml maxdb-fetch-object.xml maxdb-fetch-row.xml
maxdb-field-count.xml maxdb-field-seek.xml maxdb-field-tell.xml maxdb-free-result.xml maxdb-get-client-info.xml maxdb-get-client-version.xml
maxdb-get-host-info.xml maxdb-get-proto-info.xml maxdb-get-server-info.xml maxdb-get-server-version.xml maxdb-info.xml maxdb-init.xml
maxdb-insert-id.xml maxdb-kill.xml m! axdb-master-query.xml maxdb-more-results.xml maxdb-multi-query.xml maxdb-next-result.xml maxdb-num-fields.xml
maxdb-num-rows.xml maxdb-options.xml maxdb-ping.xml maxdb-prepare.xml maxdb-query.xml maxdb-real-connect.xml maxdb-real-escape-string.xml
maxdb-real-query.xml maxdb-report.xml maxdb-rollback.xml maxdb-rpl-parse-enabled.xml maxdb-rpl-probe.xml maxdb-rpl-query-type.xml maxdb-select-db.xml
maxdb-send-query.xml maxdb-server-end.xml maxdb-server-init.xml maxdb-sqlstate.xml maxdb-ssl-set.xml maxdb-stat.xml maxdb-stmt-affected-rows.xml
maxdb-stmt-bind-param.xml maxdb-stmt-bind-result.xml maxdb-stmt-close-long-data.xml maxdb-stmt-close.xml maxdb-stmt-data-seek.xml maxdb-stmt-errno.xml
maxdb-stmt-error.xml maxdb-stmt-execute.xml maxdb-stmt-fetch.xml maxdb-stmt-free-result.xml maxdb-stmt-init.xml maxdb-stmt-num-rows.xml
maxdb-stmt-param-count.xml maxdb-stmt-prepare.xml maxdb-stmt-reset.xml maxdb-stmt-result-metadata.xml maxdb-stmt-send-long-data.xml
maxdb-stmt-sqlstate.xml ma! xdb-stmt-store-result.xml maxdb-store-result.xml maxdb-thread-id.xml maxdb-thread-safe.xml maxdb-use-result.xml
maxdb-warning-count.xml

From:	Mehdi Achour	Date:	Mon, 29 Jan 2007 16:56:03 +0000
Subject:	cvs: phpdoc /en/reference/maxdb/functions maxdb-affected-rows.xml maxdb-autocommit.xml maxdb-change-user.xml maxdb-character-set-name.xml maxdb-close.xml maxdb-commit.xml maxdb-connect-errno.xml maxdb-connect-error.xml maxdb-connect.xml maxdb-data-seek.xml maxdb-debug.xml maxdb-disable-reads-from-master.xml maxdb-disable-rpl-parse.xml maxdb-dump-debug-info.xml maxdb-embedded-connect.xml maxdb-enable-reads-from-master.xml maxdb-enable-rpl-parse.xml maxdb-errno.xml maxdb-error.xml maxdb-fetch-array.xml maxdb-fetch-assoc.xml maxdb-fetch-field-direct.xml maxdb-fetch-field.xml maxdb-fetch-fields.xml maxdb-fetch-lengths.xml maxdb-fetch-object.xml maxdb-fetch-row.xml maxdb-field-count.xml maxdb-field-seek.xml maxdb-field-tell.xml maxdb-free-result.xml maxdb-get-client-info.xml maxdb-get-client-version.xml maxdb-get-host-info.xml maxdb-get-proto-info.xml maxdb-get-server-info.xml maxdb-get-server-version.xml maxdb-info.xml maxdb-init.xml maxdb-insert-id.xml maxdb-kill.xml m! axdb-master-query.xml maxdb-more-results.xml maxdb-multi-query.xml maxdb-next-result.xml maxdb-num-fields.xml maxdb-num-rows.xml maxdb-options.xml maxdb-ping.xml maxdb-prepare.xml maxdb-query.xml maxdb-real-connect.xml maxdb-real-escape-string.xml maxdb-real-query.xml maxdb-report.xml maxdb-rollback.xml maxdb-rpl-parse-enabled.xml maxdb-rpl-probe.xml maxdb-rpl-query-type.xml maxdb-select-db.xml maxdb-send-query.xml maxdb-server-end.xml maxdb-server-init.xml maxdb-sqlstate.xml maxdb-ssl-set.xml maxdb-stat.xml maxdb-stmt-affected-rows.xml maxdb-stmt-bind-param.xml maxdb-stmt-bind-result.xml maxdb-stmt-close-long-data.xml maxdb-stmt-close.xml maxdb-stmt-data-seek.xml maxdb-stmt-errno.xml maxdb-stmt-error.xml maxdb-stmt-execute.xml maxdb-stmt-fetch.xml maxdb-stmt-free-result.xml maxdb-stmt-init.xml maxdb-stmt-num-rows.xml maxdb-stmt-param-count.xml maxdb-stmt-prepare.xml maxdb-stmt-reset.xml maxdb-stmt-result-metadata.xml maxdb-stmt-send-long-data.xml maxdb-stmt-sqlstate.xml ma! xdb-stmt-store-result.xml maxdb-store-result.xml maxdb-thread-id.xml maxdb-thread-safe.xml maxdb-use-result.xml maxdb-warning-count.xml
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969375091@lists.php.net to get a copy of this message

didou Mon Jan 29 16:56:03 2007 UTC Modified files: /phpdoc/en/reference/maxdb/functions maxdb-affected-rows.xml maxdb-autocommit.xml maxdb-change-user.xml maxdb-character-set-name.xml maxdb-close.xml maxdb-commit.xml maxdb-connect-errno.xml maxdb-connect-error.xml maxdb-connect.xml maxdb-data-seek.xml maxdb-debug.xml maxdb-disable-reads-from-master.xml maxdb-disable-rpl-parse.xml maxdb-dump-debug-info.xml maxdb-embedded-connect.xml maxdb-enable-reads-from-master.xml maxdb-enable-rpl-parse.xml maxdb-errno.xml maxdb-error.xml maxdb-fetch-array.xml maxdb-fetch-assoc.xml maxdb-fetch-field-direct.xml maxdb-fetch-field.xml maxdb-fetch-fields.xml maxdb-fetch-lengths.xml maxdb-fetch-object.xml maxdb-fetch-row.xml maxdb-field-count.xml maxdb-field-seek.xml maxdb-field-tell.xml maxdb-free-result.xml maxdb-get-client-info.xml maxdb-get-client-version.xml maxdb-get-host-info.xml maxdb-get-proto-info.xml maxdb-get-server-info.xml maxdb-get-server-version.xml maxdb-info.xml maxdb-init.xml maxdb-insert-id.xml maxdb-kill.xml maxdb-master-query.xml maxdb-more-results.xml maxdb-multi-query.xml maxdb-next-result.xml maxdb-num-fields.xml maxdb-num-rows.xml maxdb-options.xml maxdb-ping.xml maxdb-prepare.xml maxdb-query.xml maxdb-real-connect.xml maxdb-real-escape-string.xml maxdb-real-query.xml maxdb-report.xml maxdb-rollback.xml maxdb-rpl-parse-enabled.xml maxdb-rpl-probe.xml maxdb-rpl-query-type.xml maxdb-select-db.xml maxdb-send-query.xml maxdb-server-end.xml maxdb-server-init.xml maxdb-sqlstate.xml maxdb-ssl-set.xml maxdb-stat.xml maxdb-stmt-affected-rows.xml maxdb-stmt-bind-param.xml maxdb-stmt-bind-result.xml maxdb-stmt-close-long-data.xml maxdb-stmt-close.xml maxdb-stmt-data-seek.xml maxdb-stmt-errno.xml maxdb-stmt-error.xml maxdb-stmt-execute.xml maxdb-stmt-fetch.xml maxdb-stmt-free-result.xml maxdb-stmt-init.xml maxdb-stmt-num-rows.xml maxdb-stmt-param-count.xml maxdb-stmt-prepare.xml maxdb-stmt-reset.xml maxdb-stmt-result-metadata.xml maxdb-stmt-send-long-data.xml maxdb-stmt-sqlstate.xml maxdb-stmt-store-result.xml maxdb-store-result.xml maxdb-thread-id.xml maxdb-thread-safe.xml maxdb-use-result.xml maxdb-warning-count.xml Log: WS, prepare for new docstyle

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/maxdb/functions/maxdb-affected-rows.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/maxdb/functions/maxdb-affected-rows.xml diff -u phpdoc/en/reference/maxdb/functions/maxdb-affected-rows.xml:1.3 phpdoc/en/reference/maxdb/functions/maxdb-affected-rows.xml:1.4 --- phpdoc/en/reference/maxdb/functions/maxdb-affected-rows.xml:1.3 Thu Jun 23 16:53:23 2005 +++ phpdoc/en/reference/maxdb/functions/maxdb-affected-rows.xml Mon Jan 29 16:56:01 2007 @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - <refentry id="function.maxdb-affected-rows"> + +<refentry id="function.maxdb-affected-rows"> <refnamediv> <refname>maxdb_affected_rows</refname> <refname>maxdb->affected_rows</refname> @@ -19,7 +19,7 @@ <fieldsynopsis><type>int</type><varname>affected_rows</varname></fieldsynopsis> </classsynopsis> <para> - <function>maxdb_affected_rows</function> returns the number of rows affected by the last + <function>maxdb_affected_rows</function> returns the number of rows affected by the last INSERT, UPDATE, or DELETE query associated with the provided <parameter>link</parameter> parameter. If this number cannot be determined, this function will return -1. </para> @@ -38,9 +38,9 @@ <refsect1> <title>Return Values</title> <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 - the WHERE clause in the query or that no query has yet been executed. + 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 + the WHERE clause in the query or that no query has yet been executed. -1 indicates that the number of rows affected can not be determined. </para> </refsect1> @@ -143,9 +143,9 @@ ?> ]]> </programlisting> - </example> + </example> <para> - The above examples would produce the following output: + The above examples would produce the following output: </para> <screen> <![CDATA[ http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/maxdb/functions/maxdb-autocommit.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/maxdb/functions/maxdb-autocommit.xml diff -u phpdoc/en/reference/maxdb/functions/maxdb-autocommit.xml:1.2 phpdoc/en/reference/maxdb/functions/maxdb-autocommit.xml:1.3 --- phpdoc/en/reference/maxdb/functions/maxdb-autocommit.xml:1.2 Tue Mar 8 16:39:06 2005 +++ phpdoc/en/reference/maxdb/functions/maxdb-autocommit.xml Mon Jan 29 16:56:01 2007 @@ -1,52 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_autocommit</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam><type>bool</type><parameter>mode</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method)</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>auto_commit</methodname> - <methodparam><type>bool</type><parameter>mode</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - <function>maxdb_autocommit</function> is used to turn on or off auto-commit mode - on queries for the database connection represented by the <parameter>link</parameter> - resource. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_autocommit</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam><type>bool</type><parameter>mode</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method)</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>auto_commit</methodname> + <methodparam><type>bool</type><parameter>mode</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + <function>maxdb_autocommit</function> is used to turn on or off auto-commit mode + on queries for the database connection represented by the <parameter>link</parameter> + resource. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -63,11 +63,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -84,13 +84,13 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce no output. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + <para> + The above examples would produce no output. + </para> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_change_user</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam><type>string</type><parameter>user</parameter></methodparam> - <methodparam><type>string</type><parameter>password</parameter></methodparam> - <methodparam><type>string</type><parameter>database</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>change_user</methodname> - <methodparam><type>string</type><parameter>user</parameter></methodparam> - <methodparam><type>string</type><parameter>password</parameter></methodparam> - <methodparam><type>string</type><parameter>database</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - <function>maxdb_change_user</function> is used to change the user of the specified - database connection as given by the <parameter>link</parameter> parameter and to set the - current database to that specified by the <parameter>database</parameter> parameter. - </para> - <para> - In order to successfully change users a valid <parameter>username</parameter> and - <parameter>password</parameter> parameters must be provided and that user must have - sufficient permissions to access the desired database. If for any reason authorization - fails, the current user authentication will remain. - </para> - <note> - <para> - Using this command will always cause the current database connection to behave as if - was a completely new database connection, regardless of if the operation was completed - successfully. This reset includes performing a rollback on any active transactions, - closing all temporary tables, and unlocking all locked tables. - </para> - </note> - </refsect1> - <refsect1> - <title>Return Values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_change_user</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam><type>string</type><parameter>database</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>change_user</methodname> + <methodparam><type>string</type><parameter>user</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + <methodparam><type>string</type><parameter>database</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + <function>maxdb_change_user</function> is used to change the user of the specified + database connection as given by the <parameter>link</parameter> parameter and to set the + current database to that specified by the <parameter>database</parameter> parameter. + </para> + <para> + In order to successfully change users a valid <parameter>username</parameter> and + <parameter>password</parameter> parameters must be provided and that user must have + sufficient permissions to access the desired database. If for any reason authorization + fails, the current user authentication will remain. + </para> + <note> + <para> + Using this command will always cause the current database connection to behave as if + was a completely new database connection, regardless of if the operation was completed + successfully. This reset includes performing a rollback on any active transactions, + closing all temporary tables, and unlocking all locked tables. + </para> + </note> + </refsect1> + <refsect1> + <title>Return Values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php @@ -94,11 +94,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -126,19 +126,19 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Result: a Database running ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>string</type><methodname>maxdb_character_set_name</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>string</type> - <methodname>character_set_name</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - Returns the current character set for the database connection specified by the - <parameter>link</parameter> parameter. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>string</type><methodname>maxdb_character_set_name</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>string</type> + <methodname>character_set_name</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + Returns the current character set for the database connection specified by the + <parameter>link</parameter> parameter. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php /* Open a connection */ $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); - + /* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); @@ -61,11 +61,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -84,18 +84,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would be produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would be produce the following output: + </para> + <screen> <![CDATA[ Current character set is ascii ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_close</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>close</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - The <function>maxdb_close</function> function closes a previously opened database - connection specified by the <parameter>link</parameter> parameter. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <para> - &return.success; - </para> - </refsect1> - <refsect1> - <title>See also</title> - <para> - <function>maxdb_connect</function>, - <function>maxdb_init</function>, - <function>maxdb_real_connect</function>. - </para> - </refsect1> - </refentry> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_close</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>close</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + The <function>maxdb_close</function> function closes a previously opened database + connection specified by the <parameter>link</parameter> parameter. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + &return.success; + </para> + </refsect1> + <refsect1> + <title>See also</title> + <para> + <function>maxdb_connect</function>, + <function>maxdb_init</function>, + <function>maxdb_real_connect</function>. + </para> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_commit</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method)</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>commit</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - Commits the current transaction for the database connection specified by the - <parameter>link</parameter> parameter. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_commit</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method)</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>commit</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + Commits the current transaction for the database connection specified by the + <parameter>link</parameter> parameter. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -75,11 +75,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -110,13 +110,13 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples produces no output. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + <para> + The above examples produces no output. + </para> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>int</type><methodname>maxdb_connect_errno</methodname> - <void /> - </methodsynopsis> - <para> - The <function>maxdb_connect_errno</function> function will return the last error code number - for last call to <function>maxdb_connect</function>. - If no errors have occured, this function will return zero. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <para> - <example> - <title>maxdb_connect_errno sample</title> - <programlisting role="php"> + +<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> + <methodsynopsis> + <type>int</type><methodname>maxdb_connect_errno</methodname> + <void /> + </methodsynopsis> + <para> + The <function>maxdb_connect_errno</function> function will return the last error code number + for last call to <function>maxdb_connect</function>. + If no errors have occured, this function will return zero. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <para> + <example> + <title>maxdb_connect_errno sample</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "XXXXXXXX", "YYYYYYYYY"); @@ -49,20 +49,20 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - The above example would produce the following output: + </programlisting> + </example> </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> - </refsect1> - </refentry> +</screen> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>string</type><methodname>maxdb_connect_error</methodname> - <void /> - </methodsynopsis> - <para> - The <function>maxdb_connect_error</function> function is identical to the corresponding - <function>maxdb_connect_errno</function> function in every way, except instead of returning - an integer error code the <function>maxdb_connect_error</function> function will return - a string representation of the last error to occur for the last - <function>maxdb_connect</function> call. - If no error has occured, this function will return an empty string. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <para> - <example> - <title>maxdb_connect_error sample</title> - <programlisting role="php"> + +<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> + <methodsynopsis> + <type>string</type><methodname>maxdb_connect_error</methodname> + <void /> + </methodsynopsis> + <para> + The <function>maxdb_connect_error</function> function is identical to the corresponding + <function>maxdb_connect_errno</function> function in every way, except instead of returning + an integer error code the <function>maxdb_connect_error</function> function will return + a string representation of the last error to occur for the last + <function>maxdb_connect</function> call. + If no error has occured, this function will return an empty string. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <para> + <example> + <title>maxdb_connect_error sample</title> + <programlisting role="php"> <![CDATA[ <?php @@ -52,11 +52,11 @@ } ?> ]]> - </programlisting> - </example> - </para> + </programlisting> + </example> + </para> <para> - The above example would produce the following output: + The above example would produce the following output: </para> <screen> <![CDATA[ @@ -64,8 +64,8 @@ Can't connect to localhost. Error: POS(1) Unknown user name/password combination ]]> </screen> - </refsect1> - </refentry> + </refsect1> +</refentry>  - <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> - <para>Procedural style</para> - <methodsynopsis> - <type>resource</type><methodname>maxdb_connect</methodname> - <methodparam choice='opt'><type>string</type><parameter>host</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam> - <methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (constructor):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <constructorsynopsis> - <methodname>__construct</methodname> - <methodparam choice='opt'><type>string</type><parameter>host</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam> - <methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam> - </constructorsynopsis> - </classsynopsis> - <para> - The <function>maxdb_connect</function> function attempts to open a connection to the MaxDB Server - running on <parameter>host</parameter> which can be either a host name or an IP address. Passing the - string "localhost" to this parameter, the local host is assumed. - If successful, the <function>maxdb_connect</function> - will return an resource representing the connection to the database, or &false; on failure. - </para> - <para> - The <parameter>username</parameter> and <parameter>password</parameter> parameters specify the - username and password under which to connect to the MaxDB server. If the password is not provided - (the &null; value is passed), the MaxDB server will attempt to authenticate the user against - the <parameter>maxdb.default_pw</parameter> in &php.ini;. - </para> - <para> - The <parameter>dbname</parameter> parameter if provided will specify the default database to be - used when performing queries. If not provied, the entry <parameter>maxdb.default_db</parameter> - in &php.ini; is used. - </para> - <para> - The <parameter>port</parameter> and <parameter>socket</parameter> parameters are - ignored for the MaxDB server. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <para> - Returns a resource which represents the connection to a MaxDB Server or - &false; if the connection failed. - </para> - </refsect1> - <refsect1> - <title>Example</title> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style</para> + <methodsynopsis> + <type>resource</type><methodname>maxdb_connect</methodname> + <methodparam choice='opt'><type>string</type><parameter>host</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam> + <methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (constructor):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <constructorsynopsis> + <methodname>__construct</methodname> + <methodparam choice='opt'><type>string</type><parameter>host</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam> + <methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam> + </constructorsynopsis> + </classsynopsis> + <para> + The <function>maxdb_connect</function> function attempts to open a connection to the MaxDB Server + running on <parameter>host</parameter> which can be either a host name or an IP address. Passing the + string "localhost" to this parameter, the local host is assumed. + If successful, the <function>maxdb_connect</function> + will return an resource representing the connection to the database, or &false; on failure. + </para> + <para> + The <parameter>username</parameter> and <parameter>password</parameter> parameters specify the + username and password under which to connect to the MaxDB server. If the password is not provided + (the &null; value is passed), the MaxDB server will attempt to authenticate the user against + the <parameter>maxdb.default_pw</parameter> in &php.ini;. + </para> + <para> + The <parameter>dbname</parameter> parameter if provided will specify the default database to be + used when performing queries. If not provied, the entry <parameter>maxdb.default_db</parameter> + in &php.ini; is used. + </para> + <para> + The <parameter>port</parameter> and <parameter>socket</parameter> parameters are + ignored for the MaxDB server. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + Returns a resource which represents the connection to a MaxDB Server or + &false; if the connection failed. + </para> + </refsect1> + <refsect1> + <title>Example</title> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -82,16 +82,16 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (!$link) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -103,18 +103,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Host information: localhost ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_data_seek</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - <methodparam><type>int</type><parameter>offset</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>result</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>data_seek</methodname> - <methodparam><type>int</type><parameter>offset</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - The <function>maxdb_data_seek</function> function seeks to an arbitrary result pointer - specified by the <parameter>offset</parameter> in the result set represented by - <parameter>result</parameter>. The <parameter>offset</parameter> parameter must be between - zero and the total number of rows minus one (0..<function>maxdb_num_rows</function> - 1). - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_data_seek</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>result</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>data_seek</methodname> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + The <function>maxdb_data_seek</function> function seeks to an arbitrary result pointer + specified by the <parameter>offset</parameter> in the result set represented by + <parameter>result</parameter>. The <parameter>offset</parameter> parameter must be between + zero and the total number of rows minus one (0..<function>maxdb_num_rows</function> - 1). + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php /* Open a connection */ $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -70,7 +70,7 @@ $row = $result->fetch_row(); printf ("City: %s State: %s\n", $row[0], $row[1]); - + /* free result set*/ $result->close(); } @@ -79,16 +79,16 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (!$link) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -105,7 +105,7 @@ $row = maxdb_fetch_row($result); printf ("City: %s State: %s\n", $row[0], $row[1]); - + /* free result set*/ maxdb_free_result($result); } @@ -114,18 +114,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ City: Irvine State: CA ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <refentry id="function.maxdb-debug"> - <refnamediv> - <refname>maxdb_debug</refname> - <refpurpose>Performs debugging operations</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>maxdb_debug</methodname> - <methodparam><type>string</type><parameter>debug</parameter></methodparam> - </methodsynopsis> - <para> - The <function>maxdb_debug</function> can be used to trace the SQLDBC communication. The following - strings can be used as a parameter to <function>maxdb_debug</function>: - </para> - <simplelist> - <member>TRACE SHORT ON|OFF - Enables/disables method call trace.</member> - <member>TRACE LONG ON|OFF - Enables/disables method argument and detail debug trace.</member> - <member>TRACE PACKET ON|OFF|<size> - Enables/disables packet trace, limiting the size of the - traced object to the specified number of bytes, or 1000 if no size is specified.</member> - <member>TRACE SQL ON|OFF - Enables/disables high level api trace.</member> - <member>TRACE TIMESTAMP ON|OFF - Enables/disables a timestamp prefix on each line that is - traced.</member> - <member>TRACE SIZE <size> - Limits the size of the trace file to <size> bytes, - at least 8192 bytes are required.</member> - </simplelist> - </refsect1> - <refsect1> - <title>Return values</title> - <para><function>maxdb_debug</function> doesn't return any value.</para> - </refsect1> - <refsect1> - <title>Example</title> - <example> - <title>Procedural style</title> - <programlisting role="php"> + +<refentry id="function.maxdb-debug"> + <refnamediv> + <refname>maxdb_debug</refname> + <refpurpose>Performs debugging operations</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>void</type><methodname>maxdb_debug</methodname> + <methodparam><type>string</type><parameter>debug</parameter></methodparam> + </methodsynopsis> + <para> + The <function>maxdb_debug</function> can be used to trace the SQLDBC communication. The following + strings can be used as a parameter to <function>maxdb_debug</function>: + </para> + <simplelist> + <member>TRACE SHORT ON|OFF - Enables/disables method call trace.</member> + <member>TRACE LONG ON|OFF - Enables/disables method argument and detail debug trace.</member> + <member>TRACE PACKET ON|OFF|<size> - Enables/disables packet trace, limiting the size of the + traced object to the specified number of bytes, or 1000 if no size is specified.</member> + <member>TRACE SQL ON|OFF - Enables/disables high level api trace.</member> + <member>TRACE TIMESTAMP ON|OFF - Enables/disables a timestamp prefix on each line that is + traced.</member> + <member>TRACE SIZE <size> - Limits the size of the trace file to <size> bytes, + at least 8192 bytes are required.</member> + </simplelist> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + <function>maxdb_debug</function> doesn't return any value. + </para> + </refsect1> + <refsect1> + <title>Example</title> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php - + maxdb_debug("trace packet 200"); $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (!$link) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); } /* close connection */ -maxdb_close($link); +maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above example produces no output. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + <para> + The above example produces no output. + </para> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_disable_reads_from_master</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>void</type><methodname>disable_reads_from_master</methodname> - <void /> - </methodsynopsis> - </classsynopsis> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_disable_reads_from_master</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>void</type><methodname>disable_reads_from_master</methodname> + <void /> + </methodsynopsis> + </classsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  - <refentry id="function.maxdb-disable-rpl-parse"> - <refnamediv> - <refname>maxdb_disable_rpl_parse</refname> - <refpurpose>Disable RPL parse</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>maxdb_disable_rpl_parse</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> + +<refentry id="function.maxdb-disable-rpl-parse"> + <refnamediv> + <refname>maxdb_disable_rpl_parse</refname> + <refpurpose>Disable RPL parse</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>maxdb_disable_rpl_parse</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>bool</type><methodname>maxdb_dump_debug_info</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> + +<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> + <methodsynopsis> + <type>bool</type><methodname>maxdb_dump_debug_info</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>resource</type><methodname>maxdb_embedded_connect</methodname> - <methodparam choice="opt"><type>string</type><parameter>dbname</parameter></methodparam> - </methodsynopsis> + +<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> + <methodsynopsis> + <type>resource</type><methodname>maxdb_embedded_connect</methodname> + <methodparam choice="opt"><type>string</type><parameter>dbname</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>bool</type><methodname>maxdb_enable_reads_from_master</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> + +<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> + <methodsynopsis> + <type>bool</type><methodname>maxdb_enable_reads_from_master</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  - <refentry id="function.maxdb-enable-rpl-parse"> - <refnamediv> - <refname>maxdb_enable_rpl_parse</refname> - <refpurpose>Enable RPL parse</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>maxdb_enable_rpl_parse</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> + +<refentry id="function.maxdb-enable-rpl-parse"> + <refnamediv> + <refname>maxdb_enable_rpl_parse</refname> + <refpurpose>Enable RPL parse</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>maxdb_enable_rpl_parse</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>int</type><methodname>maxdb_errno</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <fieldsynopsis><type>int</type><varname>errno</varname></fieldsynopsis> - </classsynopsis> - <para> - The <function>maxdb_errno</function> function will return the last error code for - the most recent MaxDB function call that can succeed or fail with respect to the - database link defined by the <parameter>link</parameter> parameter. If no errors - have occured, this function will return zero. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>int</type><methodname>maxdb_errno</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <fieldsynopsis><type>int</type><varname>errno</varname></fieldsynopsis> + </classsynopsis> + <para> + The <function>maxdb_errno</function> function will return the last error code for + the most recent MaxDB function call that can succeed or fail with respect to the + database link defined by the <parameter>link</parameter> parameter. If no errors + have occured, this function will return zero. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -63,11 +63,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -86,19 +86,19 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ PHP Warning: maxdb_query(): -4005 POS(8) Unknown column name:XXX [42000] <...> Errorcode: -4005 ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>string</type><methodname>maxdb_error</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property)</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <fieldsynopsis><type>string</type><varname>error</varname></fieldsynopsis> - </classsynopsis> - <para> - The <function>maxdb_error</function> function is identical to the corresponding - <function>maxdb_errno</function> function in every way, except instead of returning - an integer error code the <function>maxdb_error</function> function will return - a string representation of the last error to occur for the database connection - represented by the <parameter>link</parameter> parameter. If no error has occured, - this function will return an empty string. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>string</type><methodname>maxdb_error</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property)</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <fieldsynopsis><type>string</type><varname>error</varname></fieldsynopsis> + </classsynopsis> + <para> + The <function>maxdb_error</function> function is identical to the corresponding + <function>maxdb_errno</function> function in every way, except instead of returning + an integer error code the <function>maxdb_error</function> function will return + a string representation of the last error to occur for the database connection + represented by the <parameter>link</parameter> parameter. If no error has occured, + this function will return an empty string. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -64,11 +64,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -87,19 +87,19 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ PHP Warning: maxdb_query(): -4005 POS(8) Unknown column name:XXX [42000] Errormessgae: POS(8) Unknown column name:XXX ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>mixed</type><methodname>maxdb_fetch_array</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - <methodparam choice='opt'><type>int</type><parameter>resulttype</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>result</classname></ooclass> - <methodsynopsis> - <type>mixed</type> - <methodname>fetch_array</methodname> - <methodparam choice='opt'><type>int</type><parameter>resulttype</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - Returns an array that corresponds to the fetched row or &null; if there are no more rows for the - resultset represented by the <parameter>result</parameter> parameter. - </para> - <para> - <function>maxdb_fetch_array</function> is an extended version of the - <function>maxdb_fetch_row</function> function. In addition to storing the data in the - numeric indices of the result array, the <function>maxdb_fetch_array</function> function can - also store the data in associative indices, using the field names of the result set as keys. - </para> - &database.field-case; - &database.fetch-null; - <para> - If two or more columns of the result have the same field names, the last column will take - precedence and overwrite the earlier data. In order to access multiple columns with the same - name, the numerically indexed version of the row must be used. - </para> - <para> - The optional second argument <parameter>resulttype</parameter> is a constant indicating what - type of array should be produced from the current row data. The possible values for this parameter - are the constants MAXDB_ASSOC, MAXDB_ASSOC_UPPER, MAXDB_ASSOC_LOWER, MAXDB_NUM, or MAXDB_BOTH. - By default the - <function>maxdb_fetch_array</function> function will assume MAXDB_BOTH, which is a combination of - MAXDB_NUM and MAXDB_ASSOC for this parameter. - </para> - <para> - By using the MAXDB_ASSOC constant this function will behave identically to the - <function>maxdb_fetch_assoc</function>, while MAXDB_NUM will behave identically to the - <function>maxdb_fetch_row</function> function. The final option MAXDB_BOTH will create a single - array with the attributes of both. - </para> - <para> - By using the MAXDB_ASSOC_UPPER constant, the behaviour of this function is identical to the use - of MAXDB_ASSOC except the array index of a column is the fieldname in upper case. - </para> - <para> - By using the MAXDB_ASSOC_LOWER constant, the behaviour of this function is identical to the use - of MAXDB_ASSOC except the array index of a column is the fieldname in lower case. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>mixed</type><methodname>maxdb_fetch_array</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam choice='opt'><type>int</type><parameter>resulttype</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>result</classname></ooclass> + <methodsynopsis> + <type>mixed</type> + <methodname>fetch_array</methodname> + <methodparam choice='opt'><type>int</type><parameter>resulttype</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + Returns an array that corresponds to the fetched row or &null; if there are no more rows for the + resultset represented by the <parameter>result</parameter> parameter. + </para> + <para> + <function>maxdb_fetch_array</function> is an extended version of the + <function>maxdb_fetch_row</function> function. In addition to storing the data in the + numeric indices of the result array, the <function>maxdb_fetch_array</function> function can + also store the data in associative indices, using the field names of the result set as keys. + </para> + &database.field-case; + &database.fetch-null; + <para> + If two or more columns of the result have the same field names, the last column will take + precedence and overwrite the earlier data. In order to access multiple columns with the same + name, the numerically indexed version of the row must be used. + </para> + <para> + The optional second argument <parameter>resulttype</parameter> is a constant indicating what + type of array should be produced from the current row data. The possible values for this parameter + are the constants MAXDB_ASSOC, MAXDB_ASSOC_UPPER, MAXDB_ASSOC_LOWER, MAXDB_NUM, or MAXDB_BOTH. + By default the + <function>maxdb_fetch_array</function> function will assume MAXDB_BOTH, which is a combination of + MAXDB_NUM and MAXDB_ASSOC for this parameter. + </para> + <para> + By using the MAXDB_ASSOC constant this function will behave identically to the + <function>maxdb_fetch_assoc</function>, while MAXDB_NUM will behave identically to the + <function>maxdb_fetch_row</function> function. The final option MAXDB_BOTH will create a single + array with the attributes of both. + </para> + <para> + By using the MAXDB_ASSOC_UPPER constant, the behaviour of this function is identical to the use + of MAXDB_ASSOC except the array index of a column is the fieldname in upper case. + </para> + <para> + By using the MAXDB_ASSOC_LOWER constant, the behaviour of this function is identical to the use + of MAXDB_ASSOC except the array index of a column is the fieldname in lower case. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -91,21 +91,21 @@ printf("Connect failed: %s\n", maxdb_connect_error()); exit(); } - + $query = "SELECT name, state FROM hotel.city ORDER by zip"; $result = $maxdb->query($query); /* numeric array */ $row = $result->fetch_array(MAXDB_NUM); -printf ("%s (%s)\n", $row[0], $row[1]); +printf ("%s (%s)\n", $row[0], $row[1]); /* associative array */ $row = $result->fetch_array(MAXDB_ASSOC); -printf ("%s (%s)\n", $row["NAME"], $row["STATE"]); +printf ("%s (%s)\n", $row["NAME"], $row["STATE"]); /* associative and numeric array */ $row = $result->fetch_array(MAXDB_BOTH); -printf ("%s (%s)\n", $row[0], $row["STATE"]); +printf ("%s (%s)\n", $row[0], $row["STATE"]); /* free result set */ $result->close(); @@ -114,11 +114,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -134,15 +134,15 @@ /* numeric array */ $row = maxdb_fetch_array($result, MAXDB_NUM); -printf ("%s (%s)\n", $row[0], $row[1]); +printf ("%s (%s)\n", $row[0], $row[1]); /* associative array */ $row = maxdb_fetch_array($result, MAXDB_ASSOC); -printf ("%s (%s)\n", $row["NAME"], $row["STATE"]); +printf ("%s (%s)\n", $row["NAME"], $row["STATE"]); /* associative and numeric array */ $row = maxdb_fetch_array($result, MAXDB_BOTH); -printf ("%s (%s)\n", $row[0], $row["STATE"]); +printf ("%s (%s)\n", $row[0], $row["STATE"]); /* free result set */ maxdb_free_result($result); @@ -151,20 +151,20 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ New York (NY) New York (NY) Long Island (NY) ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>array</type><methodname>maxdb_fetch_assoc</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>result</classname></ooclass> - <methodsynopsis> - <type>array</type> - <methodname>fetch_assoc</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - Returns an associative array that corresponds to the fetched row or &null; if there are - no more rows. - </para> - <para> - The <function>maxdb_fetch_assoc</function> function is used to return an associative array - representing the next row in the result set for the result represented by the - <parameter>result</parameter> parameter, where each key in the array represents the name - of one of the result set's columns. - </para> - <para> - If two or more columns of the result have the same field names, - the last column will take precedence. To access the other - column(s) of the same name, you either need to access the - result with numeric indices by using - <function>maxdb_fetch_row</function> or add alias names. - </para> - &database.field-case; - &database.fetch-null; - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>array</type><methodname>maxdb_fetch_assoc</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>result</classname></ooclass> + <methodsynopsis> + <type>array</type> + <methodname>fetch_assoc</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + Returns an associative array that corresponds to the fetched row or &null; if there are + no more rows. + </para> + <para> + The <function>maxdb_fetch_assoc</function> function is used to return an associative array + representing the next row in the result set for the result represented by the + <parameter>result</parameter> parameter, where each key in the array represents the name + of one of the result set's columns. + </para> + <para> + If two or more columns of the result have the same field names, + the last column will take precedence. To access the other + column(s) of the same name, you either need to access the + result with numeric indices by using + <function>maxdb_fetch_row</function> or add alias names. + </para> + &database.field-case; + &database.fetch-null; + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -70,7 +70,7 @@ printf("Connect failed: %s\n", maxdb_connect_error()); exit(); } - + $query = "SELECT name, state FROM hotel.city ORDER by zip"; if ($result = $maxdb->query($query)) { @@ -88,11 +88,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -120,12 +120,12 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ New York (NY) New York (NY) @@ -153,9 +153,9 @@ Santa Clara (CA) Portland (OR) ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>mixed</type><methodname>maxdb_fetch_field_direct</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - <methodparam><type>int</type><parameter>fieldnr</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>result</classname></ooclass> - <methodsynopsis> - <type>mixed</type> - <methodname>fetch_field_direct</methodname> - <methodparam><type>int</type><parameter>fieldnr</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - <function>maxdb_fetch_field_direct</function> returns an resource which contains - field definition informations from specified resultset. The value of fieldnr must be in the - range from <literal>0</literal> to <literal>number of fields - 1</literal>. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <para> - Returns an resource which contains field definition informations or &false; if no field information - for specified <literal>fieldnr</literal> is available. - </para> - <para> - <table> - <title>Object attributes</title> - <tgroup cols='2'> - <thead> - <row> - <entry>Attribute</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>name</entry> - <entry>The name of the column</entry> - </row> - <row> - <entry>max_length</entry> - <entry>The maximum width of the field for the result set.</entry> - </row> - <row> - <entry>type</entry> - <entry>The data type used for this field</entry> - </row> - <row> - <entry>decimals</entry> - <entry>The number of decimals used (for integer fields)</entry> - </row> - </tbody> - </tgroup> - </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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>mixed</type><methodname>maxdb_fetch_field_direct</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>fieldnr</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>result</classname></ooclass> + <methodsynopsis> + <type>mixed</type> + <methodname>fetch_field_direct</methodname> + <methodparam><type>int</type><parameter>fieldnr</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + <function>maxdb_fetch_field_direct</function> returns an resource which contains + field definition informations from specified resultset. The value of fieldnr must be in the + range from <literal>0</literal> to <literal>number of fields - 1</literal>. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + Returns an resource which contains field definition informations or &false; if no field information + for specified <literal>fieldnr</literal> is available. + </para> + <para> + <table> + <title>Object attributes</title> + <tgroup cols='2'> + <thead> + <row> + <entry>Attribute</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>name</entry> + <entry>The name of the column</entry> + </row> + <row> + <entry>max_length</entry> + <entry>The maximum width of the field for the result set.</entry> + </row> + <row> + <entry>type</entry> + <entry>The data type used for this field</entry> + </row> + <row> + <entry>decimals</entry> + <entry>The number of decimals used (for integer fields)</entry> + </row> + </tbody> + </tgroup> + </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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -98,13 +96,13 @@ /* Get field information for column 'SurfaceArea' */ $finfo = $result->fetch_field_direct(1); - + printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); printf("Flags: %d\n", $finfo->flags); printf("Type: %d\n", $finfo->type); - + $result->close(); } @@ -112,11 +110,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -133,7 +131,7 @@ /* Get field information for column 'cno' */ $finfo = maxdb_fetch_field_direct($result, 1); - + printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); @@ -147,12 +145,12 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Name: CNO Table: @@ -160,9 +158,9 @@ Flags: -1 Type: 0 ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>mixed</type><methodname>maxdb_fetch_field</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>result</classname></ooclass> - <methodsynopsis> - <type>mixed</type><methodname>fetch_field</methodname> - <void/> - </methodsynopsis> - </classsynopsis> - <para> - The <function>maxdb_fetch_field</function> returns the definition of one column - of a result set as an resource. Call this function repeatedly to retrieve - information about all columns in the result set. - <function>maxdb_fetch_field</function> returns &false; when no more fields - are left. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <para> - Returns an resource which contains field definition informations or &false; if no field information - is available. - </para> - <para> - <table> - <title>Object properties</title> - <tgroup cols='2'> - <thead> - <row> - <entry>Property</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>name</entry> - <entry>The name of the column</entry> - </row> - <row> - <entry>max_length</entry> - <entry>The maximum width of the field for the result set.</entry> - </row> - <row> - <entry>type</entry> - <entry>The data type used for this field</entry> - </row> - <row> - <entry>decimals</entry> - <entry>The number of decimals used (for integer fields)</entry> - </row> - </tbody> - </tgroup> - </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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>mixed</type><methodname>maxdb_fetch_field</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>result</classname></ooclass> + <methodsynopsis> + <type>mixed</type><methodname>fetch_field</methodname> + <void/> + </methodsynopsis> + </classsynopsis> + <para> + The <function>maxdb_fetch_field</function> returns the definition of one column + of a result set as an resource. Call this function repeatedly to retrieve + information about all columns in the result set. + <function>maxdb_fetch_field</function> returns &false; when no more fields + are left. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + Returns an resource which contains field definition informations or &false; if no field information + is available. + </para> + <para> + <table> + <title>Object properties</title> + <tgroup cols='2'> + <thead> + <row> + <entry>Property</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>name</entry> + <entry>The name of the column</entry> + </row> + <row> + <entry>max_length</entry> + <entry>The maximum width of the field for the result set.</entry> + </row> + <row> + <entry>type</entry> + <entry>The data type used for this field</entry> + </row> + <row> + <entry>decimals</entry> + <entry>The number of decimals used (for integer fields)</entry> + </row> + </tbody> + </tgroup> + </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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -97,13 +97,13 @@ /* Get field information for all columns */ while ($finfo = $result->fetch_field()) { - + printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); printf("Flags: %d\n", $finfo->flags); printf("Type: %d\n\n", $finfo->type); - } + } $result->close(); } @@ -111,11 +111,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -132,7 +132,7 @@ /* Get field information for all fields */ while ($finfo = maxdb_fetch_field($result)) { - + printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); @@ -146,12 +146,12 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Name: NAME Table: @@ -165,9 +165,9 @@ Flags: -1 Type: 0 ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural Style:</para> - <methodsynopsis> - <type>mixed</type><methodname>maxdb_fetch_fields</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>result</classname></ooclass> - <methodsynopsis> - <type>mixed</type> - <methodname>fetch_fields</methodname> - <void/> - </methodsynopsis> - </classsynopsis> - <para> - This function serves an identical purpose to the <function>maxdb_fetch_field</function> - function with the single difference that, instead of returning one resource at a time for - each field, the columns are returned as an array of resources. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <para> - Returns an array of resources which contains field definition informations or &false; if no field information - is available. - </para> - <para> - <table> - <title>Object properties</title> - <tgroup cols='2'> - <thead> - <row> - <entry>Property</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>name</entry> - <entry>The name of the column</entry> - </row> - <row> - <entry>max_length</entry> - <entry>The maximum width of the field for the result set.</entry> - </row> - <row> - <entry>type</entry> - <entry>The data type used for this field</entry> - </row> - <row> - <entry>decimals</entry> - <entry>The number of decimals used (for integer fields)</entry> - </row> - </tbody> - </tgroup> - </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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural Style:</para> + <methodsynopsis> + <type>mixed</type><methodname>maxdb_fetch_fields</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>result</classname></ooclass> + <methodsynopsis> + <type>mixed</type> + <methodname>fetch_fields</methodname> + <void/> + </methodsynopsis> + </classsynopsis> + <para> + This function serves an identical purpose to the <function>maxdb_fetch_field</function> + function with the single difference that, instead of returning one resource at a time for + each field, the columns are returned as an array of resources. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + Returns an array of resources which contains field definition informations or &false; if no field information + is available. + </para> + <para> + <table> + <title>Object properties</title> + <tgroup cols='2'> + <thead> + <row> + <entry>Property</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>name</entry> + <entry>The name of the column</entry> + </row> + <row> + <entry>max_length</entry> + <entry>The maximum width of the field for the result set.</entry> + </row> + <row> + <entry>type</entry> + <entry>The data type used for this field</entry> + </row> + <row> + <entry>decimals</entry> + <entry>The number of decimals used (for integer fields)</entry> + </row> + </tbody> + </tgroup> + </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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -102,7 +102,7 @@ printf("max. Len: %d\n", $val->max_length); printf("Flags: %d\n", $val->flags); printf("Type: %d\n\n", $val->type); - } + } $result->close(); } @@ -110,11 +110,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -131,14 +131,14 @@ /* Get field information for all columns */ $finfo = maxdb_fetch_fields($result); - + foreach ($finfo as $val) { printf("Name: %s\n", $val->name); printf("Table: %s\n", $val->table); printf("max. Len: %d\n", $val->max_length); printf("Flags: %d\n", $val->flags); printf("Type: %d\n\n", $val->type); - } + } maxdb_free_result($result); } @@ -146,12 +146,12 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Name: NAME Table: @@ -165,9 +165,9 @@ Flags: -1 Type: 0 ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>array</type><methodname>maxdb_fetch_lengths</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>result</classname></ooclass> - <fieldsynopsis><type>array</type><varname>lengths</varname></fieldsynopsis> - </classsynopsis> - <para> - The <function>maxdb_fetch_lengths</function> function returns an array containing the - lengths of every column of the current row within the result set represented by the - <parameter>result</parameter> parameter. If successful, a numerically indexed array - representing the lengths of each column is returned or &false; on failure. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <para> - An array of integers representing the size of each column (not including - any terminating null characters). &false; if an error occurred. - </para> - <para> - <function>maxdb_fetch_lengths</function> is valid only for the current row of the result set. - It returns &false; if you call it before calling maxdb_fetch_row/array/resource or after retrieving - all rows in the result. - </para> - </refsect1> - <refsect1> - <title>Example</title> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>array</type><methodname>maxdb_fetch_lengths</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>result</classname></ooclass> + <fieldsynopsis><type>array</type><varname>lengths</varname></fieldsynopsis> + </classsynopsis> + <para> + The <function>maxdb_fetch_lengths</function> function returns an array containing the + lengths of every column of the current row within the result set represented by the + <parameter>result</parameter> parameter. If successful, a numerically indexed array + representing the lengths of each column is returned or &false; on failure. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + An array of integers representing the size of each column (not including + any terminating null characters). &false; if an error occurred. + </para> + <para> + <function>maxdb_fetch_lengths</function> is valid only for the current row of the result set. + It returns &false; if you call it before calling maxdb_fetch_row/array/resource or after retrieving + all rows in the result. + </para> + </refsect1> + <refsect1> + <title>Example</title> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -69,11 +69,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -101,12 +101,12 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Field 1 has Length 4 Field 2 has Length 3 @@ -115,9 +115,9 @@ Field 5 has Length 5 Field 6 has Length 21 ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>object</type><methodname>maxdb_fetch_object</methodname> - <methodparam><type>object</type><parameter>result</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>result</classname></ooclass> - <methodsynopsis> - <type>object</type><methodname>fetch_object</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - The <function>maxdb_fetch_object</function> will return the current row result set - as an object where the attributes of the object represent the names of the fields found - within the result set. If no more rows exist in the current result set, &null; is returned. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>object</type><methodname>maxdb_fetch_object</methodname> + <methodparam><type>object</type><parameter>result</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>result</classname></ooclass> + <methodsynopsis> + <type>object</type><methodname>fetch_object</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + The <function>maxdb_fetch_object</function> will return the current row result set + as an object where the attributes of the object represent the names of the fields found + within the result set. If no more rows exist in the current result set, &null; is returned. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -57,7 +57,7 @@ printf("Connect failed: %s\n", maxdb_connect_error()); exit(); } - + $query = "SELECT name, state FROM hotel.city ORDER by zip"; if ($result = $maxdb->query($query)) { @@ -75,11 +75,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -107,12 +107,12 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ New York (NY) New York (NY) @@ -140,9 +140,9 @@ Santa Clara (CA) Portland (OR) ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>mixed</type><methodname>maxdb_fetch_row</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>result</classname></ooclass> - <methodsynopsis> - <type>mixed</type> - <methodname>fetch_row</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - Returns an array that corresponds to the fetched row, or &null; if there are no more rows. - </para> - <para> - <function>maxdb_fetch_row</function> fetches one row of data from the result set represented by - <parameter>result</parameter> and returns it as an enumerated array, where each column is stored - in an array offset starting from 0 (zero). Each subsequent call to the - <function>maxdb_fetch_row</function> function will return the next row within the result set, - or &false; if there are no more rows. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>mixed</type><methodname>maxdb_fetch_row</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>result</classname></ooclass> + <methodsynopsis> + <type>mixed</type> + <methodname>fetch_row</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + Returns an array that corresponds to the fetched row, or &null; if there are no more rows. + </para> + <para> + <function>maxdb_fetch_row</function> fetches one row of data from the result set represented by + <parameter>result</parameter> and returns it as an enumerated array, where each column is stored + in an array offset starting from 0 (zero). Each subsequent call to the + <function>maxdb_fetch_row</function> function will return the next row within the result set, + or &false; if there are no more rows. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -63,7 +63,7 @@ printf("Connect failed: %s\n", maxdb_connect_error()); exit(); } - + $query = "SELECT name, state FROM hotel.city ORDER by zip"; if ($result = $maxdb->query($query)) { @@ -81,11 +81,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -113,12 +113,12 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ New York (NY) New York (NY) @@ -146,9 +146,9 @@ Santa Clara (CA) Portland (OR) ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>int</type><methodname>maxdb_field_count</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>int</type> - <methodname>field_count</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - Returns the number of columns for the most recent query on the connection - represented by the <parameter>link</parameter> parameter. This function - can be useful when using the <function>maxdb_store_result</function> - function to determine if the query should have produced a non-empty result - 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> - <refsect1> - <title>Example</title> - <para> - <example> - <title>Object oriented style</title> - <programlisting role='php'> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>int</type><methodname>maxdb_field_count</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>int</type> + <methodname>field_count</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + Returns the number of columns for the most recent query on the connection + represented by the <parameter>link</parameter> parameter. This function + can be useful when using the <function>maxdb_store_result</function> + function to determine if the query should have produced a non-empty result + 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> + <refsect1> + <title>Example</title> + <para> + <example> + <title>Object oriented style</title> + <programlisting role='php'> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -48,15 +48,15 @@ $maxdb->query("DROP TABLE friends"); maxdb_report (MAXDB_REPORT_ERROR); -$maxdb->query( "CREATE TABLE friends (id int, name varchar(20))"); - +$maxdb->query( "CREATE TABLE friends (id int, name varchar(20))"); + $maxdb->query( "INSERT INTO friends VALUES (1,'Hartmut')"); $maxdb->query( "INSERT INTO friends VALUES (2, 'Ulf')"); if ($maxdb->field_count()) { /* this was a select/show or describe query */ $result = $maxdb->store_result(); - + /* process resultset */ $row = $result->fetch_row(); @@ -68,11 +68,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role='php'> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role='php'> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -81,15 +81,15 @@ maxdb_query($link,"DROP TABLE friends"); maxdb_report (MAXDB_REPORT_ERROR); -maxdb_query($link, "CREATE TABLE friends (id int, name varchar(20))"); - +maxdb_query($link, "CREATE TABLE friends (id int, name varchar(20))"); + maxdb_query($link, "INSERT INTO friends VALUES (1,'Hartmut')"); maxdb_query($link, "INSERT INTO friends VALUES (2, 'Ulf')"); if (maxdb_field_count($link)) { /* this was a select/show or describe query */ $result = maxdb_store_result($link); - + /* process resultset */ $row = maxdb_fetch_row($result); @@ -101,14 +101,14 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - </para> - <para> - The above example produces no output. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + The above example produces no output. + </para> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_field_seek</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - <methodparam><type>int</type><parameter>fieldnr</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>result</classname></ooclass> - <methodsynopsis> - <type>bool</type><methodname>field_seek</methodname> - <methodparam><type>int</type><parameter>fieldnr</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - Sets the field cursor to the given offset. The next call to <function>maxdb_fetch_field</function> - will retrieve the field definition of the column associated with that offset. - </para> - <note> - <para>To seek to the beginning of a row, pass an offset value of zero.</para> - </note> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_field_seek</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>fieldnr</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>result</classname></ooclass> + <methodsynopsis> + <type>bool</type><methodname>field_seek</methodname> + <methodparam><type>int</type><parameter>fieldnr</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + Sets the field cursor to the given offset. The next call to <function>maxdb_fetch_field</function> + will retrieve the field definition of the column associated with that offset. + </para> + <note> + <para>To seek to the beginning of a row, pass an offset value of zero.</para> + </note> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -66,13 +64,13 @@ /* Get field information for 2nd column */ $result->field_seek(1); $finfo = $result->fetch_field(); - + printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); printf("Flags: %d\n", $finfo->flags); printf("Type: %d\n\n", $finfo->type); - + $result->close(); } @@ -80,11 +78,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -102,7 +100,7 @@ /* Get field information for 2nd column */ maxdb_field_seek($result, 1); $finfo = maxdb_fetch_field($result); - + printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); @@ -116,12 +114,12 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Name: NAME Table: @@ -129,9 +127,9 @@ Flags: -1 Type: 2 ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>int</type><methodname>maxdb_field_tell</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>result</classname></ooclass> - <fieldsynopsis> - <type>int</type> - <varname>current_field</varname> - </fieldsynopsis> - </classsynopsis> - <para> - Returns the position of the field cursor used for the last - <function>maxdb_fetch_field</function> call. This value can - be used as an argument to <function>maxdb_field_seek</function>. - </para> - </refsect1> - <refsect1> - &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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>int</type><methodname>maxdb_field_tell</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>result</classname></ooclass> + <fieldsynopsis> + <type>int</type> + <varname>current_field</varname> + </fieldsynopsis> + </classsynopsis> + <para> + Returns the position of the field cursor used for the last + <function>maxdb_fetch_field</function> call. This value can + be used as an argument to <function>maxdb_field_seek</function>. + </para> + </refsect1> + <refsect1> + &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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -67,13 +65,13 @@ /* get fieldpointer offset */ $currentfield = $result->current_field; - printf("Column %d:\n", $currentfield); + printf("Column %d:\n", $currentfield); printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); printf("Flags: %d\n", $finfo->flags); printf("Type: %d\n\n", $finfo->type); - } + } $result->close(); } @@ -81,11 +79,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -102,11 +100,11 @@ /* Get field information for all fields */ while ($finfo = maxdb_fetch_field($result)) { - + /* get fieldpointer offset */ $currentfield = maxdb_field_tell($result); - printf("Column %d:\n", $currentfield); + printf("Column %d:\n", $currentfield); printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); @@ -120,12 +118,12 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Column 1: Name: NAME @@ -141,9 +139,9 @@ Flags: -1 Type: 0 ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>void</type><methodname>maxdb_free_result</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>result</classname></ooclass> - <methodsynopsis> - <type>void</type> - <methodname>free</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - The <function>maxdb_free_result</function> function frees the memory - associated with the result represented by the - <parameter>result</parameter> parameter, which was allocated by - <function>maxdb_query</function>, <function>maxdb_store_result</function> - or <function>maxdb_use_result</function>. - </para> - <note> - <para> - You should always free your result with <function>maxdb_free_result</function>, - when your result resource is not needed anymore. - </para> - </note> - </refsect1> - <refsect1> - &reftitle.returnvalues; - <para> - This function doesn't return any value. - </para> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>maxdb_query</function>, - <function>maxdb_stmt_store_result</function>, - <function>maxdb_store_result</function>, - <function>maxdb_use_result</function>. - </para> - </refsect1> - - </refentry> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>void</type><methodname>maxdb_free_result</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>result</classname></ooclass> + <methodsynopsis> + <type>void</type> + <methodname>free</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + The <function>maxdb_free_result</function> function frees the memory + associated with the result represented by the + <parameter>result</parameter> parameter, which was allocated by + <function>maxdb_query</function>, <function>maxdb_store_result</function> + or <function>maxdb_use_result</function>. + </para> + <note> + <para> + You should always free your result with <function>maxdb_free_result</function>, + when your result resource is not needed anymore. + </para> + </note> + </refsect1> + <refsect1> + &reftitle.returnvalues; + <para> + This function doesn't return any value. + </para> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>maxdb_query</function>, + <function>maxdb_stmt_store_result</function>, + <function>maxdb_store_result</function>, + <function>maxdb_use_result</function>. + </para> + </refsect1> + +</refentry>  - <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> - <methodsynopsis> - <type>string</type><methodname>maxdb_get_client_info</methodname> - <void /> - </methodsynopsis> - <para> - The <function>maxdb_get_client_info</function> function is used to - return a string representing the client version being used in the - MaxDB extension. - </para> - </refsect1> - <refsect1> - &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> - <para> - <example> - <title>maxdb_get_client_info</title> - <programlisting role='php'> + +<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> + <methodsynopsis> + <type>string</type><methodname>maxdb_get_client_info</methodname> + <void /> + </methodsynopsis> + <para> + The <function>maxdb_get_client_info</function> function is used to + return a string representing the client version being used in the + MaxDB extension. + </para> + </refsect1> + <refsect1> + &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> + <para> + <example> + <title>maxdb_get_client_info</title> + <programlisting role='php'> <![CDATA[ <?php @@ -46,19 +46,19 @@ printf("Client library version: %s\n", maxdb_get_client_info()); ?> ]]> - </programlisting> - </example> - </para> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + </para> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Client library version: libSQLDBC <...> ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>int</type><methodname>maxdb_get_client_version</methodname> - <void/> - </methodsynopsis> - <para> - Returns client version number as an integer. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <para> - A number that represents the MaxDB client library version in format: - <literal>main_version*10000 + minor_version *100 + sub_version</literal>. - For example, 7.5.0 is returned as 70500. - </para> - <para> - This is useful to quickly determine the version of the client library - 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> - <para> - <example> - <title>maxdb_get_client_version</title> - <programlisting role='php'> + +<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> + <methodsynopsis> + <type>int</type><methodname>maxdb_get_client_version</methodname> + <void/> + </methodsynopsis> + <para> + Returns client version number as an integer. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + A number that represents the MaxDB client library version in format: + <literal>main_version*10000 + minor_version *100 + sub_version</literal>. + For example, 7.5.0 is returned as 70500. + </para> + <para> + This is useful to quickly determine the version of the client library + 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> + <para> + <example> + <title>maxdb_get_client_version</title> + <programlisting role='php'> <![CDATA[ <?php @@ -50,19 +50,19 @@ printf("Client library version: %d\n", maxdb_get_client_version()); ?> ]]> - </programlisting> - </example> - </para> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + </para> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Client library version: 7.<...> ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procdural style:</para> - <methodsynopsis> - <type>string</type><methodname>maxdb_get_host_info</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <fieldsynopsis><type>string</type><varname>host_info</varname></fieldsynopsis> - </classsynopsis> - <para> - The <function>maxdb_get_host_info</function> function returns a string - describing the connection represented by the <parameter>link</parameter> - parameter is using. - </para> - </refsect1> - <refsect1> - &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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procdural style:</para> + <methodsynopsis> + <type>string</type><methodname>maxdb_get_host_info</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <fieldsynopsis><type>string</type><varname>host_info</varname></fieldsynopsis> + </classsynopsis> + <para> + The <function>maxdb_get_host_info</function> function returns a string + describing the connection represented by the <parameter>link</parameter> + parameter is using. + </para> + </refsect1> + <refsect1> + &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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -58,11 +58,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -80,18 +80,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Host info: localhost ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>int</type><methodname>maxdb_get_proto_info</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <fieldsynopsis><type>string</type><varname>protocol_version</varname></fieldsynopsis> - </classsynopsis> - <para> - Returns an integer representing the MaxDB protocol version used by the - connection represented by the <parameter>link</parameter> parameter. - </para> - </refsect1> - <refsect1> - &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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>int</type><methodname>maxdb_get_proto_info</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <fieldsynopsis><type>string</type><varname>protocol_version</varname></fieldsynopsis> + </classsynopsis> + <para> + Returns an integer representing the MaxDB protocol version used by the + connection represented by the <parameter>link</parameter> parameter. + </para> + </refsect1> + <refsect1> + &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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -57,11 +57,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -79,18 +79,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Protocol version: 10 ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>string</type><methodname>maxdb_get_server_info</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <fieldsynopsis><type>string</type><varname>server_info</varname></fieldsynopsis> - </classsynopsis> - <para> - Returns a string representing the version of the MaxDB server that the - MaxDB extension is connected to (represented by the - <parameter>link</parameter> parameter). - </para> - </refsect1> - <refsect1> - &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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>string</type><methodname>maxdb_get_server_info</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <fieldsynopsis><type>string</type><varname>server_info</varname></fieldsynopsis> + </classsynopsis> + <para> + Returns a string representing the version of the MaxDB server that the + MaxDB extension is connected to (represented by the + <parameter>link</parameter> parameter). + </para> + </refsect1> + <refsect1> + &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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -60,11 +60,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -82,18 +82,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Server version: Kernel 7<...> ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>int</type><methodname>maxdb_get_server_version</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <fieldsynopsis><type>int</type><varname>server_version</varname></fieldsynopsis> - </classsynopsis> - <para> - The <function>maxdb_get_server_version</function> function returns the - version of the server connected to (represented by the - <parameter>link</parameter> parameter) as an integer. - </para> - <para> - The form of this version number is - <literal>main_version * 10000 + minor_version * 100 + sub_version</literal> - (i.e. version 7.5.0 is 70500). - </para> - </refsect1> - <refsect1> - &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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>int</type><methodname>maxdb_get_server_version</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <fieldsynopsis><type>int</type><varname>server_version</varname></fieldsynopsis> + </classsynopsis> + <para> + The <function>maxdb_get_server_version</function> function returns the + version of the server connected to (represented by the + <parameter>link</parameter> parameter) as an integer. + </para> + <para> + The form of this version number is + <literal>main_version * 10000 + minor_version * 100 + sub_version</literal> + (i.e. version 7.5.0 is 70500). + </para> + </refsect1> + <refsect1> + &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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -64,11 +64,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -86,18 +86,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Server version: 7<...> ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>string</type><methodname>maxdb_info</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property)</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <fieldsynopsis><type>string</type><varname>info</varname></fieldsynopsis> - </classsynopsis> - <para> - The <function>maxdb_info</function> function returns a string providing - information about the last query executed. The nature of this string is - provided below: - </para> - <para> - <table> - <title>Possible maxdb_info return values</title> - <tgroup cols='2'> - <thead> - <row> - <entry>Query type</entry> - <entry>Example result string</entry> - </row> - </thead> - <tbody> - <row> - <entry>INSERT INTO...SELECT...</entry> - <entry>Records: 100 Duplicates: 0 Warnings: 0</entry> - </row> - <row> - <entry>INSERT INTO...VALUES (...),(...),(...)</entry> - <entry>Records: 3 Duplicates: 0 Warnings: 0</entry> - </row> - <row> - <entry>LOAD DATA INFILE ...</entry> - <entry>Records: 1 Deleted: 0 Skipped: 0 Warnings: 0</entry> - </row> - <row> - <entry>ALTER TABLE ...</entry> - <entry>Records: 3 Duplicates: 0 Warnings: 0</entry> - </row> - <row> - <entry>UPDATE ...</entry> - <entry>Rows matched: 40 Changed: 40 Warnings: 0</entry> - </row> - </tbody> - </tgroup> - </table> - </para> - <note> - <para> - Queries which do not fall into one of the above formats are not supported. - In these situations, <function>maxdb_info</function> will return an empty string. - </para> - </note> - </refsect1> - <refsect1> - &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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>string</type><methodname>maxdb_info</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property)</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <fieldsynopsis><type>string</type><varname>info</varname></fieldsynopsis> + </classsynopsis> + <para> + The <function>maxdb_info</function> function returns a string providing + information about the last query executed. The nature of this string is + provided below: + </para> + <para> + <table> + <title>Possible maxdb_info return values</title> + <tgroup cols='2'> + <thead> + <row> + <entry>Query type</entry> + <entry>Example result string</entry> + </row> + </thead> + <tbody> + <row> + <entry>INSERT INTO...SELECT...</entry> + <entry>Records: 100 Duplicates: 0 Warnings: 0</entry> + </row> + <row> + <entry>INSERT INTO...VALUES (...),(...),(...)</entry> + <entry>Records: 3 Duplicates: 0 Warnings: 0</entry> + </row> + <row> + <entry>LOAD DATA INFILE ...</entry> + <entry>Records: 1 Deleted: 0 Skipped: 0 Warnings: 0</entry> + </row> + <row> + <entry>ALTER TABLE ...</entry> + <entry>Records: 3 Duplicates: 0 Warnings: 0</entry> + </row> + <row> + <entry>UPDATE ...</entry> + <entry>Rows matched: 40 Changed: 40 Warnings: 0</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <note> + <para> + Queries which do not fall into one of the above formats are not supported. + In these situations, <function>maxdb_info</function> will return an empty string. + </para> + </note> + </refsect1> + <refsect1> + &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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -104,11 +104,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -129,18 +129,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Records: 25 Duplicates: 0 Warnings: 0 ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>resource</type><methodname>maxdb_init</methodname> - <void/> - </methodsynopsis> + +<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> + <methodsynopsis> + <type>resource</type><methodname>maxdb_init</methodname> + <void/> + </methodsynopsis> + <para> + Allocates or initializes a MaxDB resource suitable for + <function>maxdb_options</function> and <function>maxdb_real_connect</function>. + </para> + <note> <para> - Allocates or initializes a MaxDB resource suitable for - <function>maxdb_options</function> and <function>maxdb_real_connect</function>. + Any subsequent calls to any maxdb function (except <function>maxdb_options</function>) + will fail until <function>maxdb_real_connect</function> was called. </para> - <note> - <para> - Any subsequent calls to any maxdb function (except <function>maxdb_options</function>) - will fail until <function>maxdb_real_connect</function> was called. - </para> - </note> - </refsect1> - <refsect1> - &reftitle.returnvalues; - <para> - Returns an resource. - </para> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>maxdb_options</function>, - <function>maxdb_close</function>, - <function>maxdb_real_connect</function>, - <function>maxdb_connect</function> - </para> - </refsect1> - </refentry> + </note> + </refsect1> + <refsect1> + &reftitle.returnvalues; + <para> + Returns an resource. + </para> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>maxdb_options</function>, + <function>maxdb_close</function>, + <function>maxdb_real_connect</function>, + <function>maxdb_connect</function> + </para> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>mixed</type><methodname>maxdb_insert_id</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <fieldsynopsis><type>mixed</type><varname>insert_id</varname></fieldsynopsis> - </classsynopsis> - <para> - The <function>maxdb_insert_id</function> function returns the ID generated - by a query on a table with a column having the DEFAULT SERIAL attribute. If - the last query wasn't an INSERT or UPDATE statement or if the modified table - does not have a column with the DEFAULT SERIAL attribute, this function will - return zero. - </para> - </refsect1> - <refsect1> - &reftitle.returnvalues; - <para> - The value of the <literal>DEFAULT SERIAL</literal> field that was updated - by the previous query. Returns zero if there was no previous query on the - connection or if the query did not update an <literal>DEFAULT_SERIAL</literal> - value. + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>mixed</type><methodname>maxdb_insert_id</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <fieldsynopsis><type>mixed</type><varname>insert_id</varname></fieldsynopsis> + </classsynopsis> + <para> + The <function>maxdb_insert_id</function> function returns the ID generated + by a query on a table with a column having the DEFAULT SERIAL attribute. If + the last query wasn't an INSERT or UPDATE statement or if the modified table + does not have a column with the DEFAULT SERIAL attribute, this function will + return zero. </para> - <note> + </refsect1> + <refsect1> + &reftitle.returnvalues; + <para> + The value of the <literal>DEFAULT SERIAL</literal> field that was updated + by the previous query. Returns zero if there was no previous query on the + connection or if the query did not update an <literal>DEFAULT_SERIAL</literal> + value. + </para> + <note> <para> - If the number is greater than maximal int value, <function>maxdb_insert_id</function> + If the number is greater than maximal int value, <function>maxdb_insert_id</function> will return a string. </para> </note> @@ -75,7 +75,7 @@ $maxdb->close(); ?> ]]> - </programlisting> + </programlisting> </example> <example> <title>Procedural style</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/maxdb/functions/maxdb-kill.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/maxdb/functions/maxdb-kill.xml diff -u phpdoc/en/reference/maxdb/functions/maxdb-kill.xml:1.2 phpdoc/en/reference/maxdb/functions/maxdb-kill.xml:1.3 --- phpdoc/en/reference/maxdb/functions/maxdb-kill.xml:1.2 Tue Mar 8 16:39:06 2005 +++ phpdoc/en/reference/maxdb/functions/maxdb-kill.xml Mon Jan 29 16:56:01 2007 @@ -1,48 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_kill</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam><type>int</type><parameter>processid</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method)</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>kill</methodname> - <methodparam><type>int</type><parameter>processid</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - This function is used to disconnect from a MaxDB server specified - by the <parameter>processid</parameter> parameter. - </para> - </refsect1> - <refsect1> - &reftitle.returnvalues; - <para>&return.success;</para> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>maxdb_thread_id</function> - </para> - </refsect1> - <refsect1> - <title>Example</title> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_kill</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam><type>int</type><parameter>processid</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method)</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>kill</methodname> + <methodparam><type>int</type><parameter>processid</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + This function is used to disconnect from a MaxDB server specified + by the <parameter>processid</parameter> parameter. + </para> + </refsect1> + <refsect1> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>maxdb_thread_id</function> + </para> + </refsect1> + <refsect1> + <title>Example</title> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -69,11 +71,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -100,18 +102,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Error: Session not connected ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>bool</type><methodname>maxdb_master_query</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - </methodsynopsis> + +<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> + <methodsynopsis> + <type>bool</type><methodname>maxdb_master_query</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>bool</type><methodname>maxdb_more_results</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - <function>maxdb_more_results</function> indicates if one or more result sets - 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> - <para> - <function>maxdb_multi_query</function>, - <function>maxdb_next_result</function>, - <function>maxdb_store_result</function>, - <function>maxdb_use_result</function> - </para> - </refsect1> - <refsect1> - <title>Example</title> - <para>See <function>maxdb_multi_query</function>.</para> - </refsect1> - </refentry> + +<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> + <methodsynopsis> + <type>bool</type><methodname>maxdb_more_results</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + <function>maxdb_more_results</function> indicates if one or more result sets + 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> + <para> + <function>maxdb_multi_query</function>, + <function>maxdb_next_result</function>, + <function>maxdb_store_result</function>, + <function>maxdb_use_result</function> + </para> + </refsect1> + <refsect1> + <title>Example</title> + <para> + See <function>maxdb_multi_query</function>. + </para> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_multi_query</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>multi_query</methodname> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - The <function>maxdb_multi_query</function> works like the function - <function>maxdb_query</function>. Multiple queries are not yet supported. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_multi_query</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>multi_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + The <function>maxdb_multi_query</function> works like the function + <function>maxdb_query</function>. Multiple queries are not yet supported. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -81,11 +81,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -119,18 +119,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ a ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>bool</type><methodname>maxdb_next_result</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - Since multiple queries are not yet supported, <function>maxdb_next_result</function> - returns always &false;. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <para>&false;</para> - </refsect1> - <refsect1> - <title>See also</title> - <para> - <function>maxdb_multi_query</function>, - <function>maxdb_more_results</function>, - <function>maxdb_store_result</function>, - <function>maxdb_use_result</function> - </para> - </refsect1> - </refentry> + +<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> + <methodsynopsis> + <type>bool</type><methodname>maxdb_next_result</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + Since multiple queries are not yet supported, <function>maxdb_next_result</function> + returns always &false;. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <para>&false;</para> + </refsect1> + <refsect1> + <title>See also</title> + <para> + <function>maxdb_multi_query</function>, + <function>maxdb_more_results</function>, + <function>maxdb_store_result</function>, + <function>maxdb_use_result</function> + </para> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>int</type><methodname>maxdb_num_fields</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>result</classname></ooclass> - <fieldsynopsis><type>int</type><varname>field_count</varname></fieldsynopsis> - </classsynopsis> - <para> - <function>maxdb_num_fields</function> returns the number of fields from specified result set. - </para> - </refsect1> - <refsect1> - &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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>int</type><methodname>maxdb_num_fields</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>result</classname></ooclass> + <fieldsynopsis><type>int</type><varname>field_count</varname></fieldsynopsis> + </classsynopsis> + <para> + <function>maxdb_num_fields</function> returns the number of fields from specified result set. + </para> + </refsect1> + <refsect1> + &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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -64,11 +62,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -94,18 +92,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Result set has 3 fields. ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>int</type><methodname>maxdb_num_rows</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <fieldsynopsis><type>int</type><varname>num_rows</varname></fieldsynopsis> - </classsynopsis> - <para> - Returns the number of rows in the result set. - </para> - <para> - The use of <function>maxdb_num_rows</function> depends on whether you use - buffered or unbuffered result sets. - In case you use unbuffered resultsets <function>maxdb_num_rows</function> - will not correct the correct number of rows until all the rows in the result - have been retrieved. - </para> - </refsect1> - <refsect1> - &reftitle.returnvalues; - <para> - Returns number of rows in the result set. - </para> - <note> - <para> - If the number of rows is greater than maximal int value, the number - will be returned as a string. - </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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>int</type><methodname>maxdb_num_rows</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <fieldsynopsis><type>int</type><varname>num_rows</varname></fieldsynopsis> + </classsynopsis> + <para> + Returns the number of rows in the result set. + </para> + <para> + The use of <function>maxdb_num_rows</function> depends on whether you use + buffered or unbuffered result sets. + In case you use unbuffered resultsets <function>maxdb_num_rows</function> + will not correct the correct number of rows until all the rows in the result + have been retrieved. + </para> + </refsect1> + <refsect1> + &reftitle.returnvalues; + <para> + Returns number of rows in the result set. + </para> + <note> + <para> + If the number of rows is greater than maximal int value, the number + will be returned as a string. + </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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -81,11 +79,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -111,18 +109,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Result set has 15 rows. ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <refentry id="function.maxdb-options"> - <refnamediv> - <refname>maxdb_options</refname> - <refname>maxdb->options</refname> - <refpurpose>Set options</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_options</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam><type>int</type><parameter>option</parameter></methodparam> - <methodparam><type>mixed</type><parameter>value</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method)</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>options</methodname> - <methodparam><type>int</type><parameter>option</parameter></methodparam> - <methodparam><type>mixed</type><parameter>value</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - <function>maxdb_options</function> can be used to set extra connect options - and affect behavior for a connection. - </para> - <para> - This function may be called multiple times to set several options. - </para> - <para> - <function>maxdb_options</function> should be called after <function>maxdb_init</function> - and before <function>maxdb_real_connect</function>. - </para> - <para> - The parameter <parameter>option</parameter> is the option that you want to set, - the <parameter>value</parameter> is the value for the option. For detailed - description of the options see <ulink url="&url.maxdb.doc;">&url.maxdb.doc;</ulink> - The parameter <parameter>option</parameter> can be one of the following values: - <table> - <title>Valid options</title> - <tgroup cols='2'> - <thead> - <row> - <entry>Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><constant>MAXDB_COMPNAME</constant></entry> - <entry>The component name used to initialise the SQLDBC runtime environment.</entry> - </row> - <row> - <entry><constant>MAXDB_APPLICATION</constant></entry> - <entry>The application to be connected to the database.</entry> - </row> - <row> - <entry><constant>MAXDB_APPVERSION</constant></entry> - <entry>The version of the application.</entry> - </row> - <row> - <entry><constant>MAXDB_SQLMODE</constant></entry> - <entry> - The SQL mode. - </entry> - </row> - <row> - <entry><constant>MAXDB_UNICODE</constant></entry> - <entry> - TRUE, if the connection is an unicode (UCS2) client or FALSE, if not. - </entry> - </row> - <row> - <entry><constant>MAXDB_TIMEOUT</constant></entry> - <entry> - The maximum allowed time of inactivity after which the connection to the - database is closed by the system. - </entry> - </row> - <row> - <entry><constant>MAXDB_ISOLATIONLEVEL</constant></entry> - <entry> - Specifies whether and how shared locks and exclusive locks are implicitly - requested or released. - </entry> - </row> - <row> - <entry><constant>MAXDB_PACKETCOUNT</constant></entry> - <entry> - The number of different request packets used for the connection. - </entry> - </row> - <row> - <entry><constant>MAXDB_STATEMENTCACHESIZE</constant></entry> - <entry> - The number of prepared statements to be cached for the connection for re-use. - </entry> - </row> - <row> - <entry><constant>MAXDB_CURSORPREFIX</constant></entry> - <entry> - The prefix to use for result tables that are automatically named. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </refsect1> - <refsect1> - &reftitle.returnvalues; - <para>&return.success;</para> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>maxdb_init</function>, - <function>maxdb_real_connect</function> - </para> - </refsect1> - <refsect1> - <title>Example</title> - <para>See <function>maxdb_real_connect</function>.</para> - </refsect1> - </refentry> + +<refentry id="function.maxdb-options"> + <refnamediv> + <refname>maxdb_options</refname> + <refname>maxdb->options</refname> + <refpurpose>Set options</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_options</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam><type>int</type><parameter>option</parameter></methodparam> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method)</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>options</methodname> + <methodparam><type>int</type><parameter>option</parameter></methodparam> + <methodparam><type>mixed</type><parameter>value</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + <function>maxdb_options</function> can be used to set extra connect options + and affect behavior for a connection. + </para> + <para> + This function may be called multiple times to set several options. + </para> + <para> + <function>maxdb_options</function> should be called after <function>maxdb_init</function> + and before <function>maxdb_real_connect</function>. + </para> + <para> + The parameter <parameter>option</parameter> is the option that you want to set, + the <parameter>value</parameter> is the value for the option. For detailed + description of the options see <ulink url="&url.maxdb.doc;">&url.maxdb.doc;</ulink> + The parameter <parameter>option</parameter> can be one of the following values: + <table> + <title>Valid options</title> + <tgroup cols='2'> + <thead> + <row> + <entry>Name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>MAXDB_COMPNAME</constant></entry> + <entry>The component name used to initialise the SQLDBC runtime environment.</entry> + </row> + <row> + <entry><constant>MAXDB_APPLICATION</constant></entry> + <entry>The application to be connected to the database.</entry> + </row> + <row> + <entry><constant>MAXDB_APPVERSION</constant></entry> + <entry>The version of the application.</entry> + </row> + <row> + <entry><constant>MAXDB_SQLMODE</constant></entry> + <entry> + The SQL mode. + </entry> + </row> + <row> + <entry><constant>MAXDB_UNICODE</constant></entry> + <entry> + TRUE, if the connection is an unicode (UCS2) client or FALSE, if not. + </entry> + </row> + <row> + <entry><constant>MAXDB_TIMEOUT</constant></entry> + <entry> + The maximum allowed time of inactivity after which the connection to the + database is closed by the system. + </entry> + </row> + <row> + <entry><constant>MAXDB_ISOLATIONLEVEL</constant></entry> + <entry> + Specifies whether and how shared locks and exclusive locks are implicitly + requested or released. + </entry> + </row> + <row> + <entry><constant>MAXDB_PACKETCOUNT</constant></entry> + <entry> + The number of different request packets used for the connection. + </entry> + </row> + <row> + <entry><constant>MAXDB_STATEMENTCACHESIZE</constant></entry> + <entry> + The number of prepared statements to be cached for the connection for re-use. + </entry> + </row> + <row> + <entry><constant>MAXDB_CURSORPREFIX</constant></entry> + <entry> + The prefix to use for result tables that are automatically named. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </refsect1> + <refsect1> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>maxdb_init</function>, + <function>maxdb_real_connect</function> + </para> + </refsect1> + <refsect1> + <title>Example</title> + <para>See <function>maxdb_real_connect</function>.</para> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_ping</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>bool</type><methodname>ping</methodname> - <void/> - </methodsynopsis> - </classsynopsis> - <para> - Checks whether the connection to the server is working. If it has gone - down, and global option <literal>maxdb.reconnect</literal> is enabled - an automatic reconnection is attempted. - </para> - <para> - This function can be used by clients that remain idle for a long while, - to check whether the server has closed the connection and reconnect if - necessary. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <para>&return.success;</para> - </refsect1> - <refsect1> - <title>Example</title> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_ping</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>bool</type><methodname>ping</methodname> + <void/> + </methodsynopsis> + </classsynopsis> + <para> + Checks whether the connection to the server is working. If it has gone + down, and global option <literal>maxdb.reconnect</literal> is enabled + an automatic reconnection is attempted. + </para> + <para> + This function can be used by clients that remain idle for a long while, + to check whether the server has closed the connection and reconnect if + necessary. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + &return.success; + </para> + </refsect1> + <refsect1> + <title>Example</title> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -64,11 +64,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -90,18 +90,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Our connection is ok! ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedure style:</para> - <methodsynopsis> - <type>resource</type><methodname>maxdb_prepare</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method)</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <methodsynopsis> - <type>resource</type><methodname>prepare</methodname> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - <function>maxdb_prepare</function> prepares the SQL query pointed to by the - null-terminated string query, and returns a statement handle to be used for - further operations on the statement. The query must consist of a single SQL statement. - </para> - <note> - <para> - You should not add a terminating semicolon or <literal>\g</literal> - to the statement. - </para> - </note> - <para> - The parameter <parameter>query</parameter> can include one or more parameter markers - in the SQL statement by embedding question mark (<literal>?</literal>) characters - at the appropriate positions. - </para> - <note> - <para> - The markers are legal only in certain places in SQL statements. - For example, they are allowed in the VALUES() list of an INSERT statement - (to specify column values for a row), or in a comparison with a column in - a WHERE clause to specify a comparison value. - </para> - <para> - However, they are not allowed for identifiers (such as table or column names), - in the select list that names the columns to be returned by a SELECT statement), - or to specify both operands of a binary operator such as the <literal>=</literal> - equal sign. The latter restriction is necessary because it would be impossible - to determine the parameter type. In general, parameters are legal only in Data - Manipulation Languange (DML) statements, and not in Data Defination Language - (DDL) statements. - </para> - </note> - <para> - The parameter markers must be bound to application variables using - <function>maxdb_stmt_bind_param</function> and/or <function>maxdb_stmt_bind_result</function> - before executing the statement or fetching rows. - </para> - </refsect1> - <refsect1> - &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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedure style:</para> + <methodsynopsis> + <type>resource</type><methodname>maxdb_prepare</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method)</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <methodsynopsis> + <type>resource</type><methodname>prepare</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + <function>maxdb_prepare</function> prepares the SQL query pointed to by the + null-terminated string query, and returns a statement handle to be used for + further operations on the statement. The query must consist of a single SQL statement. + </para> + <note> + <para> + You should not add a terminating semicolon or <literal>\g</literal> + to the statement. + </para> + </note> + <para> + The parameter <parameter>query</parameter> can include one or more parameter markers + in the SQL statement by embedding question mark (<literal>?</literal>) characters + at the appropriate positions. + </para> + <note> + <para> + The markers are legal only in certain places in SQL statements. + For example, they are allowed in the VALUES() list of an INSERT statement + (to specify column values for a row), or in a comparison with a column in + a WHERE clause to specify a comparison value. + </para> + <para> + However, they are not allowed for identifiers (such as table or column names), + in the select list that names the columns to be returned by a SELECT statement), + or to specify both operands of a binary operator such as the <literal>=</literal> + equal sign. The latter restriction is necessary because it would be impossible + to determine the parameter type. In general, parameters are legal only in Data + Manipulation Languange (DML) statements, and not in Data Defination Language + (DDL) statements. + </para> + </note> + <para> + The parameter markers must be bound to application variables using + <function>maxdb_stmt_bind_param</function> and/or <function>maxdb_stmt_bind_result</function> + before executing the statement or fetching rows. + </para> + </refsect1> + <refsect1> + &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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -115,17 +113,17 @@ /* close statement */ $stmt->close(); -} +} /* close connection */ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -157,24 +155,24 @@ /* close statement */ maxdb_stmt_close($stmt); -} +} /* close connection */ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Rosemont is in district IL ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>mixed</type><methodname>maxdb_query</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - <methodparam choice='opt'><type>int</type><parameter>resultmode</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>mixed</type> - <methodname>query</methodname> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - The <function>maxdb_query</function> function is used to simplify the - act of performing a query against the database represented by the - <parameter>link</parameter> parameter. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>mixed</type><methodname>maxdb_query</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam choice='opt'><type>int</type><parameter>resultmode</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>mixed</type> + <methodname>query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + The <function>maxdb_query</function> function is used to simplify the + act of performing a query against the database represented by the + <parameter>link</parameter> parameter. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -82,11 +82,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -118,19 +118,19 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Table mycity successfully created. Select returned 25 rows. ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_real_connect</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>hostname</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam> - <methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method)</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>real_connect</methodname> - <methodparam choice='opt'><type>string</type><parameter>hostname</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam> - <methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam> - <methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam> - </methodsynopsis> - </classsynopsis> + +<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> + <para>Procedural style</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_real_connect</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam> + <methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method)</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>real_connect</methodname> + <methodparam choice='opt'><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam> + <methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam> + <methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + <function>maxdb_real_connect</function> attempts to establish a + connection to a MaxDB database engine running on + <parameter>hostname</parameter>. + </para> + <para> + This function differs from <function>maxdb_connect</function>: + </para> + <itemizedlist> + <listitem> <para> - <function>maxdb_real_connect</function> attempts to establish a - connection to a MaxDB database engine running on - <parameter>hostname</parameter>. - </para> - <para> - This function differs from <function>maxdb_connect</function>: + <function>maxdb_real_connect</function> needs a valid resource which has + to be created by function <function>maxdb_init</function> </para> - <itemizedlist> - <listitem> - <para> - <function>maxdb_real_connect</function> needs a valid resource which has - to be created by function <function>maxdb_init</function> - </para> - </listitem> - <listitem> - <para> - With function <function>maxdb_options</function> you can set various options for connection. - </para> - </listitem> - </itemizedlist> - </refsect1> - <refsect1> - &reftitle.returnvalues; - <para>&return.success;</para> - </refsect1> - <refsect1> - &reftitle.seealso; + </listitem> + <listitem> <para> - <function>maxdb_connect</function>, - <function>maxdb_init</function>, - <function>maxdb_options</function>, - <function>maxdb_ssl_set</function>, - <function>maxdb_close</function>. + With function <function>maxdb_options</function> you can set various options for connection. </para> - </refsect1> - <refsect1> - <title>Example</title> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + </listitem> + </itemizedlist> + </refsect1> + <refsect1> + &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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php @@ -98,11 +100,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php @@ -127,18 +129,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Connection: localhost <...> ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>string</type><methodname>maxdb_real_escape_string</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam><type>string</type><parameter>escapestr</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>string</type> - <methodname>real_escape_sring</methodname> - <methodparam><type>string</type><parameter>escapestr</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - This function is used to create a legal SQL string that you can use in a SQL statement. - The string <literal>escapestr</literal> is encoded to an escaped SQL string, taking into - account the current character set of the connection. - </para> - <para> - Characters encoded are <literal>', "</literal>. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>string</type><methodname>maxdb_real_escape_string</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam><type>string</type><parameter>escapestr</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>string</type> + <methodname>real_escape_sring</methodname> + <methodparam><type>string</type><parameter>escapestr</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + This function is used to create a legal SQL string that you can use in a SQL statement. + The string <literal>escapestr</literal> is encoded to an escaped SQL string, taking into + account the current character set of the connection. + </para> + <para> + Characters encoded are <literal>', "</literal>. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -76,16 +73,16 @@ /* this query with escaped $city will work */ if ($maxdb->query("INSERT into temp.mycity VALUES ('22222','$city','NY')")) { printf("%d Row inserted.\n", $maxdb->affected_rows); -} +} $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -110,25 +107,25 @@ /* this query with escaped $city will work */ if (maxdb_query($link, "INSERT into temp.mycity VALUES ('22222','$city','NY')")) { printf("%d Row inserted.\n", maxdb_affected_rows($link)); -} +} maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Warning: maxdb_query(): -5016 POS(43) Missing delimiter: ) <...> Error: 42000 1 Row inserted. ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_real_query</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>real_query</methodname> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - The <function>maxdb_real_query</function> is functionally identical - with the <function>maxdb_query</function>. - </para> - <note> - <para> - In order to determine if a given query should return a result set or not, - see <function>maxdb_field_count</function>. - </para> - </note> - </refsect1> - <refsect1> - <title>Return values</title> - <para> - &return.success; - </para> - </refsect1> - <refsect1> - <title>See also</title> - <para> - <function>maxdb_query</function> - <function>maxdb_store_result</function> - <function>maxdb_use_result</function> - </para> - </refsect1> - </refentry> + +<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> + <para>Procedural style</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_real_query</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>real_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + The <function>maxdb_real_query</function> is functionally identical + with the <function>maxdb_query</function>. + </para> + <note> + <para> + In order to determine if a given query should return a result set or not, + see <function>maxdb_field_count</function>. + </para> + </note> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + &return.success; + </para> + </refsect1> + <refsect1> + <title>See also</title> + <para> + <function>maxdb_query</function> + <function>maxdb_store_result</function> + <function>maxdb_use_result</function> + </para> + </refsect1> +</refentry>  - <refentry id="function.maxdb-report"> - <refnamediv> - <refname>maxdb_report</refname> - <refpurpose>Enables or disables internal report functions</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>maxdb_report</methodname> - <methodparam><type>int</type><parameter>flags</parameter></methodparam> - </methodsynopsis> - - </refsect1> - <refsect1> - <title>Example</title> - <example> - <title>Procedural style</title> - <programlisting role="php"> + +<refentry id="function.maxdb-report"> + <refnamediv> + <refname>maxdb_report</refname> + <refpurpose>Enables or disables internal report functions</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>maxdb_report</methodname> + <methodparam><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> + </refsect1> + <refsect1> + <title>Example</title> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php /* activate reporting */ @@ -37,18 +36,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Warning: maxdb_query(): -4004 POS(18) Unknown table name:NONEXISTINGTABLE <...> ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>bool</type><methodname>maxdb_rollback</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>rollback</methodname> - <void/> - </methodsynopsis> - </classsynopsis> - <para> - Rollbacks the current transaction for the database specified by the - <parameter>link</parameter> parameter. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <methodsynopsis> + <type>bool</type><methodname>maxdb_rollback</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>rollback</methodname> + <void/> + </methodsynopsis> + </classsynopsis> + <para> + Rollbacks the current transaction for the database specified by the + <parameter>link</parameter> parameter. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -88,11 +88,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -138,19 +138,19 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ 0 rows in table mycity. 25 rows in table mycity (after rollback). ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>int</type><methodname>maxdb_rpl_parse_enabled</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> + +<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> + <methodsynopsis> + <type>int</type><methodname>maxdb_rpl_parse_enabled</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  - <refentry id="function.maxdb-rpl-probe"> - <refnamediv> - <refname>maxdb_rpl_probe</refname> - <refpurpose>RPL probe</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>maxdb_rpl_probe</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> + +<refentry id="function.maxdb-rpl-probe"> + <refnamediv> + <refname>maxdb_rpl_probe</refname> + <refpurpose>RPL probe</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>maxdb_rpl_probe</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>int</type><methodname>maxdb_rpl_query_type</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method)</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>int</type><methodname>rpl_query_type</methodname> - <void/> - </methodsynopsis> - </classsynopsis> + +<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> + <methodsynopsis> + <type>int</type><methodname>maxdb_rpl_query_type</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method)</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>int</type><methodname>rpl_query_type</methodname> + <void/> + </methodsynopsis> + </classsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>bool</type><methodname>maxdb_select_db</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam><type>string</type><parameter>dbname</parameter></methodparam> - </methodsynopsis> - <para> - The <function>maxdb_select_db</function> function selects the default - database (specified by the <parameter>dbname</parameter> parameter) to be - used when performing queries against the database connection - represented by the <parameter>link</parameter> parameter. - </para> - <note> - <para> - This function should only be used to change the default database for the connection. - You can select the default database with 4th parameter in <function>maxdb_connect</function>. - </para> - </note> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <methodsynopsis> + <type>bool</type><methodname>maxdb_select_db</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam><type>string</type><parameter>dbname</parameter></methodparam> + </methodsynopsis> + <para> + The <function>maxdb_select_db</function> function selects the default + database (specified by the <parameter>dbname</parameter> parameter) to be + used when performing queries against the database connection + represented by the <parameter>link</parameter> parameter. + </para> + <note> + <para> + This function should only be used to change the default database for the connection. + You can select the default database with 4th parameter in <function>maxdb_connect</function>. + </para> + </note> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -74,11 +74,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -109,12 +109,12 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Default database is <...>. @@ -124,9 +124,9 @@ Warning: maxdb_close(): -10821 Session not connected [] <...> ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>bool</type><methodname>maxdb_send_query</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method)</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>bool</type><methodname>send_query</methodname> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - </methodsynopsis> - </classsynopsis> + +<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> + <methodsynopsis> + <type>bool</type><methodname>maxdb_send_query</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method)</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>bool</type><methodname>send_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> + </classsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  - <refentry id="function.maxdb-server-end"> - <refnamediv> - <refname>maxdb_server_end</refname> - <refpurpose>Shut down the embedded server</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>maxdb_server_end</methodname> - <void/> - </methodsynopsis> + +<refentry id="function.maxdb-server-end"> + <refnamediv> + <refname>maxdb_server_end</refname> + <refpurpose>Shut down the embedded server</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>void</type><methodname>maxdb_server_end</methodname> + <void/> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  - <refentry id="function.maxdb-server-init"> - <refnamediv> - <refname>maxdb_server_init</refname> - <refpurpose>Initialize embedded server</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>maxdb_server_init</methodname> - <methodparam choice="opt"><type>array</type><parameter>server</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>groups</parameter></methodparam> - </methodsynopsis> + +<refentry id="function.maxdb-server-init"> + <refnamediv> + <refname>maxdb_server_init</refname> + <refpurpose>Initialize embedded server</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>maxdb_server_init</methodname> + <methodparam choice="opt"><type>array</type><parameter>server</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>groups</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>string</type><methodname>maxdb_sqlstate</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <fieldsynopsis><type>string</type><varname>sqlstate</varname></fieldsynopsis> - </classsynopsis> - <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. - The values are specified by ANSI SQL and ODBC. - </para> - <note> - <para> - Note that not all MaxDB errors are yet mapped to SQLSTATE's. - The value <literal>HY000</literal> (general error) is used for unmapped errors. - </para> - </note> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>string</type><methodname>maxdb_sqlstate</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <fieldsynopsis><type>string</type><varname>sqlstate</varname></fieldsynopsis> + </classsynopsis> + <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. + The values are specified by ANSI SQL and ODBC. + </para> + <note> + <para> + Note that not all MaxDB errors are yet mapped to SQLSTATE's. + The value <literal>HY000</literal> (general error) is used for unmapped errors. + </para> + </note> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -67,11 +67,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -90,19 +90,19 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Warning: maxdb_query(): -6000 POS(20) Duplicate table name:CITY [I6000] <...> Error - SQLSTATE I6000. ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_ssl_set</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - <methodparam><type>string</type><parameter>key</parameter></methodparam> - <methodparam><type>string</type><parameter>cert</parameter></methodparam> - <methodparam><type>string</type><parameter>ca</parameter></methodparam> - <methodparam><type>string</type><parameter>capath</parameter></methodparam> - <methodparam><type>string</type><parameter>cipher</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>bool</type><methodname>ssl_set</methodname> - <methodparam><type>string</type><parameter>key</parameter></methodparam> - <methodparam><type>string</type><parameter>cert</parameter></methodparam> - <methodparam><type>string</type><parameter>ca</parameter></methodparam> - <methodparam><type>string</type><parameter>capath</parameter></methodparam> - <methodparam><type>string</type><parameter>cipher</parameter></methodparam> - </methodsynopsis> - </classsynopsis> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_ssl_set</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>cert</parameter></methodparam> + <methodparam><type>string</type><parameter>ca</parameter></methodparam> + <methodparam><type>string</type><parameter>capath</parameter></methodparam> + <methodparam><type>string</type><parameter>cipher</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>bool</type><methodname>ssl_set</methodname> + <methodparam><type>string</type><parameter>key</parameter></methodparam> + <methodparam><type>string</type><parameter>cert</parameter></methodparam> + <methodparam><type>string</type><parameter>ca</parameter></methodparam> + <methodparam><type>string</type><parameter>capath</parameter></methodparam> + <methodparam><type>string</type><parameter>cipher</parameter></methodparam> + </methodsynopsis> + </classsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>string</type><methodname>maxdb_stat</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>string</type><methodname>maxdb->stat</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - <function>maxdb_stat</function> returns a string containing several - information about the MaxDB server running. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>string</type><methodname>maxdb_stat</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>string</type><methodname>maxdb->stat</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + <function>maxdb_stat</function> returns a string containing several + information about the MaxDB server running. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -58,11 +58,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -78,18 +78,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ System status: Kernel 7<...> ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <refentry id="function.maxdb-stmt-affected-rows"> - <refnamediv> - <refname>maxdb_stmt_affected_rows</refname> - <refname>maxdb_stmt->affected_rows</refname> - <refpurpose>Returns the total number of rows changed, deleted, or - inserted by the last executed statement - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para>Procedural style :</para> - <methodsynopsis> - <type>int</type><methodname>maxdb_stmt_affected_rows</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <fieldsynopsis><type>int</type><varname>affected_rows</varname></fieldsynopsis> - </classsynopsis> - <para> - <function>maxdb_stmt_affected_rows</function> returns the number of rows affected - by INSERT, UPDATE, or DELETE query. If the last query was invalid or the - number of rows can not determined, this function will return -1. - </para> - </refsect1> - <refsect1> - <title>Return Values</title> - <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 - rows matched the WHERE clause in the query or that no query has yet been executed. - -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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<refentry id="function.maxdb-stmt-affected-rows"> + <refnamediv> + <refname>maxdb_stmt_affected_rows</refname> + <refname>maxdb_stmt->affected_rows</refname> + <refpurpose>Returns the total number of rows changed, deleted, or + inserted by the last executed statement + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para>Procedural style :</para> + <methodsynopsis> + <type>int</type><methodname>maxdb_stmt_affected_rows</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <fieldsynopsis><type>int</type><varname>affected_rows</varname></fieldsynopsis> + </classsynopsis> + <para> + <function>maxdb_stmt_affected_rows</function> returns the number of rows affected + by INSERT, UPDATE, or DELETE query. If the last query was invalid or the + number of rows can not determined, this function will return -1. + </para> + </refsect1> + <refsect1> + <title>Return Values</title> + <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 + rows matched the WHERE clause in the query or that no query has yet been executed. + -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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -68,7 +68,7 @@ /* Bind variable for placeholder */ $code = 'N%'; $stmt->bind_param("s", $code); - + /* execute statement */ $stmt->execute(); @@ -82,11 +82,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -108,7 +108,7 @@ /* Bind variable for placeholder */ $code = 'N%'; maxdb_stmt_bind_param($stmt, "s", $code); - + /* execute statement */ maxdb_stmt_execute($stmt); @@ -122,18 +122,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ rows inserted: 4 ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_stmt_bind_param</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - <methodparam><type>string</type><parameter>types</parameter></methodparam> - <methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam> - <methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>bind_param</methodname> - <methodparam><type>string</type><parameter>types</parameter></methodparam> - <methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam> - <methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para>Procedural style (extended syntax):</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_stmt_bind_param</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - <methodparam><type>string</type><parameter>types</parameter></methodparam> - <methodparam><type>array</type><parameter role="reference">var</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method) (extended syntax):</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>bind_param</methodname> - <methodparam><type>string</type><parameter>types</parameter></methodparam> - <methodparam><type>array</type><parameter role="reference">var</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - <function>maxdb_stmt_bind_param</function> is used to bind variables for the - parameter markers in the SQL statement that was passed to - <function>maxdb_prepare</function>. - The string <parameter>types</parameter> contains one or more characters which specify - the types for the corresponding bind variables. - </para> - <para> - The extended syntax of <function>maxdb_stmt_bind_param</function> allows to give the parameters - as an array instead of a variable list of PHP variables to the function. If the array variable has not been - used before calling <function>maxdb_stmt_bind_param</function>, it has to be initialized as an emtpy - array. See the examples how to use <function>maxdb_stmt_bind_param</function> with extended syntax. - </para> - <para> - Variables for SELECT INTO SQL statements can also be bound using <function>maxdb_stmt_bind_param</function>. - Parameters for database procedures can be bound using <function>maxdb_stmt_bind_param</function>. See the - examples how to use <function>maxdb_stmt_bind_param</function> in this cases. - </para> - <para> - If a variable bound as INTO variable to a SQL statement was used before, the content of this variable - is overwritten by the data of the SELECT INTO statement. A reference to this variable will be invalid after a call to - <function>maxdb_stmt_bind_param</function>. - </para> - <para> - For INOUT parameters of database procedures the content of the bound INOUT variable is overwritten by the output - value of the database procedure. A reference to this variable will be invalid after a call to - <function>maxdb_stmt_bind_param</function>. - </para> - <para> - <table> - <title>Type specification chars</title> - <tgroup cols='2'> - <thead> - <row> - <entry>Character</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>i</entry> - <entry>corresponding variable has type integer</entry> - </row> - <row> - <entry>d</entry> - <entry>corresponding variable has type double</entry> - </row> - <row> - <entry>s</entry> - <entry>corresponding variable has type string</entry> - </row> - <row> - <entry>b</entry> - <entry>corresponding variable is a blob and will be sent in packages</entry> - </row> - </tbody> - </tgroup> - </table> - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_stmt_bind_param</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam><type>string</type><parameter>types</parameter></methodparam> + <methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>bind_param</methodname> + <methodparam><type>string</type><parameter>types</parameter></methodparam> + <methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para>Procedural style (extended syntax):</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_stmt_bind_param</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam><type>string</type><parameter>types</parameter></methodparam> + <methodparam><type>array</type><parameter role="reference">var</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method) (extended syntax):</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>bind_param</methodname> + <methodparam><type>string</type><parameter>types</parameter></methodparam> + <methodparam><type>array</type><parameter role="reference">var</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + <function>maxdb_stmt_bind_param</function> is used to bind variables for the + parameter markers in the SQL statement that was passed to + <function>maxdb_prepare</function>. + The string <parameter>types</parameter> contains one or more characters which specify + the types for the corresponding bind variables. + </para> + <para> + The extended syntax of <function>maxdb_stmt_bind_param</function> allows to give the parameters + as an array instead of a variable list of PHP variables to the function. If the array variable has not been + used before calling <function>maxdb_stmt_bind_param</function>, it has to be initialized as an emtpy + array. See the examples how to use <function>maxdb_stmt_bind_param</function> with extended syntax. + </para> + <para> + Variables for SELECT INTO SQL statements can also be bound using <function>maxdb_stmt_bind_param</function>. + Parameters for database procedures can be bound using <function>maxdb_stmt_bind_param</function>. See the + examples how to use <function>maxdb_stmt_bind_param</function> in this cases. + </para> + <para> + If a variable bound as INTO variable to a SQL statement was used before, the content of this variable + is overwritten by the data of the SELECT INTO statement. A reference to this variable will be invalid after a call to + <function>maxdb_stmt_bind_param</function>. + </para> + <para> + For INOUT parameters of database procedures the content of the bound INOUT variable is overwritten by the output + value of the database procedure. A reference to this variable will be invalid after a call to + <function>maxdb_stmt_bind_param</function>. + </para> + <para> + <table> + <title>Type specification chars</title> + <tgroup cols='2'> + <thead> + <row> + <entry>Character</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>i</entry> + <entry>corresponding variable has type integer</entry> + </row> + <row> + <entry>d</entry> + <entry>corresponding variable has type double</entry> + </row> + <row> + <entry>s</entry> + <entry>corresponding variable has type string</entry> + </row> + <row> + <entry>b</entry> + <entry>corresponding variable is a blob and will be sent in packages</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb('localhost', 'MONA', 'RED', 'DEMODB'); @@ -163,11 +163,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -204,20 +204,20 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ 1 Row inserted. 1 Row deleted. ]]> - </screen> - <example> - <title>Procedural style (SELECT INTO)</title> - <programlisting role="php"> + </screen> + <example> + <title>Procedural style (SELECT INTO)</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -227,7 +227,7 @@ printf("Connect failed: %s\n", maxdb_connect_error()); exit(); } - + /* Performing SQL query */ $stmt = maxdb_prepare ($link, "SELECT price INTO ? FROM hotel.room where hno = ? and type = ?"); if (!$stmt) { @@ -245,19 +245,19 @@ maxdb_stmt_close ($stmt); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ 21.600000 ]]> - </screen> - <example> - <title>Procedural style (DB procedure)</title> - <programlisting role="php"> + </screen> + <example> + <title>Procedural style (DB procedure)</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -290,19 +290,19 @@ maxdb_stmt_close ($stmt); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ a ]]> - </screen> - <example> - <title>Object oriented style (extended syntax)</title> - <programlisting role="php"> + </screen> + <example> + <title>Object oriented style (extended syntax)</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb('localhost', 'MONA', 'RED', 'DEMODB'); @@ -359,12 +359,12 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ 1 Row inserted. 1 Row inserted. @@ -372,9 +372,9 @@ 22222 New Orleans LA 2 Rows deleted. ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_stmt_bind_result</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - <methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam> - <methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>bind_result</methodname> - <methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam> - <methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - <function>maxdb_stmt_bind_result</function> is used to associate (bind) columns in the result - set to variables. When <function>maxdb_stmt_fetch</function> is called to fetch data, the MaxDB - client/server protocol places the data for the bound columns into the specified variables - <parameter>var1, ...</parameter>. - </para> - <note> - <para> - Note that all columns must be bound prior to calling <function>maxdb_stmt_fetch</function>. - Depending on column types bound variables can silently change to the corresponding PHP type. - </para> - <para> - A column can be bound or rebound at any time, even after a result set has been partially retrieved. - The new binding takes effect the next time <function>maxdb_stmt_fetch</function> is called. - </para> - </note> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_stmt_bind_result</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>bind_result</methodname> + <methodparam><type>mixed</type><parameter role="reference">var1</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter role="reference">...</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + <function>maxdb_stmt_bind_result</function> is used to associate (bind) columns in the result + set to variables. When <function>maxdb_stmt_fetch</function> is called to fetch data, the MaxDB + client/server protocol places the data for the bound columns into the specified variables + <parameter>var1, ...</parameter>. + </para> + <note> + <para> + Note that all columns must be bound prior to calling <function>maxdb_stmt_fetch</function>. + Depending on column types bound variables can silently change to the corresponding PHP type. + </para> + <para> + A column can be bound or rebound at any time, even after a result set has been partially retrieved. + The new binding takes effect the next time <function>maxdb_stmt_fetch</function> is called. + </para> + </note> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -95,11 +95,11 @@ ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -130,12 +130,12 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ 12203 Albany 60601 Chicago @@ -163,9 +163,9 @@ 20019 Washington 20037 Washington ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_stmt_close_long_data</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - <methodparam><type>int</type><parameter>param_nr</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb_stmt</classname></ooclass> - <methodsynopsis> - <type>bool</type><methodname>maxdb_stmt->close_long_data</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - This function has to be called after a sequence of - <function>maxdb_stmt_send_long_data</function>, that was started - after <function>maxdb_execute</function>. - </para> - <para> - <parameter>param_nr</parameter> indicates which parameter to associate the - end of data with. - Parameters are numbered beginning with 0. - </para> - </refsect1> - <refsect1> - &reftitle.returnvalues; - <para>&return.success;</para> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>maxdb_prepare</function>, - <function>maxdb_stmt_bind_param</function> - </para> - </refsect1> - </refentry> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_stmt_close_long_data</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam><type>int</type><parameter>param_nr</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb_stmt</classname></ooclass> + <methodsynopsis> + <type>bool</type><methodname>maxdb_stmt->close_long_data</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + This function has to be called after a sequence of + <function>maxdb_stmt_send_long_data</function>, that was started + after <function>maxdb_execute</function>. + </para> + <para> + <parameter>param_nr</parameter> indicates which parameter to associate the + end of data with. + Parameters are numbered beginning with 0. + </para> + </refsect1> + <refsect1> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>maxdb_prepare</function>, + <function>maxdb_stmt_bind_param</function> + </para> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_stmt_close</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb_stmt</classname></ooclass> - <methodsynopsis> - <type>bool</type><methodname>maxdb_stmt->close</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - Closes a prepared statement. <function>maxdb_stmt_close</function> also deallocates the - statement handle pointed to by <parameter>stmt</parameter>. - If the current statement has pending or unread results, this function cancels them so that - the next query can be executed. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <para>&return.success;</para> - </refsect1> - <refsect1> - <title>See also</title> - <para> - <function>maxdb_prepare</function>, - </para> - </refsect1> - </refentry> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_stmt_close</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb_stmt</classname></ooclass> + <methodsynopsis> + <type>bool</type><methodname>maxdb_stmt->close</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + Closes a prepared statement. <function>maxdb_stmt_close</function> also deallocates the + statement handle pointed to by <parameter>stmt</parameter>. + If the current statement has pending or unread results, this function cancels them so that + the next query can be executed. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + &return.success; + </para> + </refsect1> + <refsect1> + <title>See also</title> + <para> + <function>maxdb_prepare</function>, + </para> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_stmt_data_seek</methodname> - <methodparam><type>resource</type><parameter>statement</parameter></methodparam> - <methodparam><type>int</type><parameter>offset</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>data_seek</methodname> - <methodparam><type>int</type><parameter>offset</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - The <function>maxdb_stmt_data_seek</function> function seeks to an arbitrary result pointer - specified by the <parameter>offset</parameter> in the statement result set represented by - <parameter>statement</parameter>. The <parameter>offset</parameter> parameter must be between - zero and the total number of rows minus one (0..<function>maxdb_stmt_num_rows</function> - 1). - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <para> - &return.success; - </para> - </refsect1> - <refsect1> - <title>See also</title> - <para> - <function>maxdb_prepare</function> - </para> - </refsect1> - <refsect1> - <title>Example</title> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_stmt_data_seek</methodname> + <methodparam><type>resource</type><parameter>statement</parameter></methodparam> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>data_seek</methodname> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + The <function>maxdb_stmt_data_seek</function> function seeks to an arbitrary result pointer + specified by the <parameter>offset</parameter> in the statement result set represented by + <parameter>statement</parameter>. The <parameter>offset</parameter> parameter must be between + zero and the total number of rows minus one (0..<function>maxdb_stmt_num_rows</function> - 1). + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + &return.success; + </para> + </refsect1> + <refsect1> + <title>See also</title> + <para> + <function>maxdb_prepare</function> + </para> + </refsect1> + <refsect1> + <title>Example</title> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php /* Open a connection */ $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -86,17 +86,17 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php /* Open a connection */ $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -130,18 +130,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ City: Dallas Zip: 75243 ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style :</para> - <methodsynopsis> - <type>int</type><methodname>maxdb_stmt_errno</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <fieldsynopsis><type>int</type><varname>errno</varname></fieldsynopsis> - </classsynopsis> - <para> - For the statement specified by <literal>stmt</literal>, <function>maxdb_stmt_errno</function> - returns the error code for the most recently invoked statement function that can succeed or fail. - </para> - <note> - <para> - For possible error codes see documentation of SQLDBC: - <ulink url="&url.maxdb.doc;">&url.maxdb.doc;</ulink>. - </para> - </note> - </refsect1> - <refsect1> - <title>Return values</title> - <para> - An error code value. Zero means no error occurred. - </para> - </refsect1> - <refsect1> - <title>See also</title> - <para> - <function>maxdb_stmt_error</function>, - <function>maxdb_stmt_sqlstate</function> - </para> - </refsect1> - <refsect1> - <title>Example</title> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style :</para> + <methodsynopsis> + <type>int</type><methodname>maxdb_stmt_errno</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <fieldsynopsis><type>int</type><varname>errno</varname></fieldsynopsis> + </classsynopsis> + <para> + For the statement specified by <literal>stmt</literal>, <function>maxdb_stmt_errno</function> + returns the error code for the most recently invoked statement function that can succeed or fail. + </para> + <note> + <para> + For possible error codes see documentation of SQLDBC: + <ulink url="&url.maxdb.doc;">&url.maxdb.doc;</ulink>. + </para> + </note> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + An error code value. Zero means no error occurred. + </para> + </refsect1> + <refsect1> + <title>See also</title> + <para> + <function>maxdb_stmt_error</function>, + <function>maxdb_stmt_sqlstate</function> + </para> + </refsect1> + <refsect1> + <title>Example</title> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php /* Open a connection */ $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -81,17 +81,17 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php /* Open a connection */ $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -120,19 +120,19 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Warning: maxdb_stmt_execute(): -4004 POS(23) Unknown table name:MYCITY [42000] <...> Error: -4004. ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>string</type><methodname>maxdb_stmt_error</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <fieldsynopsis><type>string</type><varname>error</varname></fieldsynopsis> - </classsynopsis> - <para> - For the statement specified by <literal>stmt</literal>, <function>maxdb_stmt_error</function> - returns a containing the error message for the most recently invoked statement function that - can succeed or fail. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>string</type><methodname>maxdb_stmt_error</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <fieldsynopsis><type>string</type><varname>error</varname></fieldsynopsis> + </classsynopsis> + <para> + For the statement specified by <literal>stmt</literal>, <function>maxdb_stmt_error</function> + returns a containing the error message for the most recently invoked statement function that + can succeed or fail. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php /* Open a connection */ $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -76,17 +76,17 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php /* Open a connection */ $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -115,19 +115,19 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Warning: maxdb_stmt_execute(): -4004 POS(23) Unknown table name:MYCITY [42000] <...> Error: POS(23) Unknown table name:MYCITY. ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_stmt_execute</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>execute</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - The <function>maxdb_stmt_execute</function> function executes a query that has been previously - prepared using the <function>maxdb_prepare</function> function represented by the - <parameter>stmt</parameter> resource. When executed any parameter markers which exist will - automatically be replaced with the appropiate data. - </para> - <para> - If the statement is UPDATE, DELETE, or INSERT, the total number of affected rows can be - determined by using the <function>maxdb_stmt_affected_rows</function> function. Likewise, - if the query yields a result set the <function>maxdb_fetch</function> function is used. - </para> - <note> - <para> - When using <function>maxdb_stmt_execute</function>, the <function>maxdb_fetch</function> - function must be used to fetch the data prior to preforming any additional queries. - </para> - </note> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_stmt_execute</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <methodsynopsis> + <type>bool</type> + <methodname>execute</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + The <function>maxdb_stmt_execute</function> function executes a query that has been previously + prepared using the <function>maxdb_prepare</function> function represented by the + <parameter>stmt</parameter> resource. When executed any parameter markers which exist will + automatically be replaced with the appropiate data. + </para> + <para> + If the statement is UPDATE, DELETE, or INSERT, the total number of affected rows can be + determined by using the <function>maxdb_stmt_affected_rows</function> function. Likewise, + if the query yields a result set the <function>maxdb_fetch</function> function is used. + </para> + <note> + <para> + When using <function>maxdb_stmt_execute</function>, the <function>maxdb_fetch</function> + function must be used to fetch the data prior to preforming any additional queries. + </para> + </note> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); - + /* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); } - + $maxdb->query("CREATE TABLE temp.mycity LIKE hotel.city"); - + /* Prepare an insert statement */ $query = "INSERT INTO temp.mycity (zip, name, state) VALUES (?,?,?)"; $stmt = $maxdb->prepare($query); @@ -77,14 +79,14 @@ $val1 = '11111'; $val2 = 'Georgetown'; $val3 = 'NY'; - + /* Execute the statement */ $stmt->execute(); $val1 = '22222'; $val2 = 'Hubbatown'; $val3 = 'CA'; - + /* Execute the statement */ $stmt->execute(); @@ -104,27 +106,27 @@ /* remove table */ $maxdb->query("DROP TABLE temp.mycity"); -/* close connection */ -$maxdb->close(); +/* close connection */ +$maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); - + /* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); } - + maxdb_query($link, "CREATE TABLE temp.mycity LIKE hotel.city"); - + /* Prepare an insert statement */ $query = "INSERT INTO temp.mycity (zip, name, state) VALUES (?,?,?)"; $stmt = maxdb_prepare($link, $query); @@ -134,14 +136,14 @@ $val1 = '11111'; $val2 = 'Georgetown'; $val3 = 'NY'; - + /* Execute the statement */ maxdb_stmt_execute($stmt); $val1 = '22222'; $val2 = 'Hubbatown'; $val3 = 'CA'; - + /* Execute the statement */ maxdb_stmt_execute($stmt); @@ -161,23 +163,23 @@ /* remove table */ maxdb_query($link, "DROP TABLE temp.mycity"); -/* close connection */ -maxdb_close($link); +/* close connection */ +maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ 11111 (Georgetown,NY) 22222 (Hubbatown,CA) ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_stmt_fetch</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <methodsynopsis> - <type>bool</type><methodname>fetch</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - <function>maxdb_stmt_fetch</function> returns row data using the variables bound by <function>maxdb_stmt_bind_result</function>. - </para> - <note> - <para> - Note that all columns must be bound by the application before calling <function>maxdb_stmt_fetch</function>. - </para> - </note> - </refsect1> - <refsect1> - <title>Return values</title> - <table> - <title>Return values</title> - <tgroup cols='2'> - <thead> - <row> - <entry>Value</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>&true;</entry> - <entry>Success. Data has been fetched</entry> - </row> - <row> - <entry>&false;</entry> - <entry>Error occured</entry> - </row> - <row> - <entry><literal>&null;</literal></entry> - <entry>No more rows/data exists</entry> - </row> - </tbody> - </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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_stmt_fetch</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <methodsynopsis> + <type>bool</type><methodname>fetch</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + <function>maxdb_stmt_fetch</function> returns row data using the variables + bound by <function>maxdb_stmt_bind_result</function>. + </para> + <note> + <para> + Note that all columns must be bound by the application before calling <function>maxdb_stmt_fetch</function>. + </para> + </note> + </refsect1> + <refsect1> + <title>Return values</title> + <table> + <title>Return values</title> + <tgroup cols='2'> + <thead> + <row> + <entry>Value</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>&true;</entry> + <entry>Success. Data has been fetched</entry> + </row> + <row> + <entry>&false;</entry> + <entry>Error occured</entry> + </row> + <row> + <entry><literal>&null;</literal></entry> + <entry>No more rows/data exists</entry> + </row> + </tbody> + </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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -83,7 +82,7 @@ printf("Connect failed: %s\n", maxdb_connect_error()); exit(); } - + $query = "SELECT zip, name FROM hotel.city ORDER by name"; if ($stmt = $maxdb->prepare($query)) { @@ -107,11 +106,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -145,12 +144,12 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ 12203 (Albany) 60601 (Chicago) @@ -178,9 +177,9 @@ 20019 (Washington) 20037 (Washington) ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>void</type><methodname>maxdb_stmt_free_result</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <methodsynopsis> - <type>void</type> - <methodname>free_result</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - The <function>maxdb_stmt_free_result</function> function frees the result memory - associated with the statement represented by the - <parameter>stmt</parameter> parameter, which was allocated by - <function>maxdb_stmt_store_result</function>. - </para> - </refsect1> - <refsect1> - &reftitle.returnvalues; - <para> - This function doesn't return any value. - </para> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>maxdb_stmt_store_result</function> - </para> - </refsect1> - - </refentry> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>void</type><methodname>maxdb_stmt_free_result</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <methodsynopsis> + <type>void</type> + <methodname>free_result</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + The <function>maxdb_stmt_free_result</function> function frees the result memory + associated with the statement represented by the + <parameter>stmt</parameter> parameter, which was allocated by + <function>maxdb_stmt_store_result</function>. + </para> + </refsect1> + <refsect1> + &reftitle.returnvalues; + <para> + This function doesn't return any value. + </para> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>maxdb_stmt_store_result</function> + </para> + </refsect1> + +</refentry>  - <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> - <para>Procedural style :</para> - <methodsynopsis> - <type>resource</type><methodname>maxdb_stmt_init</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>object</type> - <methodname>stmt_init</methodname> - <void/> - </methodsynopsis> - </classsynopsis> + +<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> + <para>Procedural style :</para> + <methodsynopsis> + <type>resource</type><methodname>maxdb_stmt_init</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>object</type><methodname>stmt_init</methodname> + <void/> + </methodsynopsis> + </classsynopsis> + <para> + Allocates and initializes a statement resource suitable for + <function>maxdb_stmt_prepare</function>. + </para> + <note> <para> - Allocates and initializes a statement resource suitable for - <function>maxdb_stmt_prepare</function>. + Any subsequent calls to any maxdb_stmt function + will fail until <function>maxdb_stmt_prepare</function> was called. </para> - <note> - <para> - Any subsequent calls to any maxdb_stmt function - will fail until <function>maxdb_stmt_prepare</function> was called. - </para> - </note> - </refsect1> - <refsect1> - &reftitle.returnvalues; - <para> - Returns an resource. - </para> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>maxdb_stmt_prepare</function> - </para> - </refsect1> - </refentry> + </note> + </refsect1> + <refsect1> + &reftitle.returnvalues; + <para> + Returns an resource. + </para> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>maxdb_stmt_prepare</function> + </para> + </refsect1> +</refentry>  - <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> - <para>Procedural style :</para> - <methodsynopsis> - <type>int</type><methodname>maxdb_stmt_num_rows</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <fieldsynopsis><type>int</type><varname>num_rows</varname></fieldsynopsis> - </classsynopsis> - <para> - Returns the number of rows in the result set. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style :</para> + <methodsynopsis> + <type>int</type><methodname>maxdb_stmt_num_rows</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <fieldsynopsis><type>int</type><varname>num_rows</varname></fieldsynopsis> + </classsynopsis> + <para> + Returns the number of rows in the result set. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php /* Open a connection */ $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -71,17 +71,17 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php /* Open a connection */ $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -106,18 +106,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Number of rows: 25. ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>int</type><methodname>maxdb_stmt_param_count</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <fieldsynopsis><type>int</type><varname>param_count</varname></fieldsynopsis> - </classsynopsis> - <para> - <function>maxdb_stmt_param_count</function> returns the number of parameter - markers present in the prepared statement. - </para> - </refsect1> - <refsect1> - &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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>int</type><methodname>maxdb_stmt_param_count</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <fieldsynopsis><type>int</type><varname>param_count</varname></fieldsynopsis> + </classsynopsis> + <para> + <function>maxdb_stmt_param_count</function> returns the number of parameter + markers present in the prepared statement. + </para> + </refsect1> + <refsect1> + &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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -63,11 +63,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -91,18 +91,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Statement has 2 markers. ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedure style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_stmt_prepare</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method)</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <methodsynopsis> - <type>mixed</type> - <methodname>prepare</methodname> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - <function>maxdb_stmt_prepare</function> prepares the SQL query pointed to by the - null-terminated string query. The statement resource has to be allocated by - <function>maxdb_stmt_init</function>. - The query must consist of a single SQL statement. - </para> - <note> - <para> - You should not add a terminating semicolon or <literal>\g</literal> - to the statement. - </para> - </note> - <para> - The parameter <parameter>query</parameter> can include one or more parameter markers - in the SQL statement by embedding question mark (<literal>?</literal>) characters - at the appropriate positions. - </para> - <note> - <para> - The markers are legal only in certain places in SQL statements. - For example, they are allowed in the VALUES() list of an INSERT statement - (to specify column values for a row), or in a comparison with a column in - a WHERE clause to specify a comparison value. - </para> - <para> - However, they are not allowed for identifiers (such as table or column names), - in the select list that names the columns to be returned by a SELECT statement), - or to specify both operands of a binary operator such as the <literal>=</literal> - equal sign. The latter restriction is necessary because it would be impossible - to determine the parameter type. In general, parameters are legal only in Data - Manipulation Languange (DML) statements, and not in Data Defination Language - (DDL) statements. - </para> - </note> - <para> - The parameter markers must be bound to application variables using - <function>maxdb_stmt_bind_param</function> and/or <function>maxdb_stmt_bind_result</function> - before executing the statement or fetching rows. - </para> - </refsect1> - <refsect1> - &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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedure style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_stmt_prepare</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method)</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <methodsynopsis> + <type>mixed</type> + <methodname>prepare</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + <function>maxdb_stmt_prepare</function> prepares the SQL query pointed to by the + null-terminated string query. The statement resource has to be allocated by + <function>maxdb_stmt_init</function>. + The query must consist of a single SQL statement. + </para> + <note> + <para> + You should not add a terminating semicolon or <literal>\g</literal> + to the statement. + </para> + </note> + <para> + The parameter <parameter>query</parameter> can include one or more parameter markers + in the SQL statement by embedding question mark (<literal>?</literal>) characters + at the appropriate positions. + </para> + <note> + <para> + The markers are legal only in certain places in SQL statements. + For example, they are allowed in the VALUES() list of an INSERT statement + (to specify column values for a row), or in a comparison with a column in + a WHERE clause to specify a comparison value. + </para> + <para> + However, they are not allowed for identifiers (such as table or column names), + in the select list that names the columns to be returned by a SELECT statement), + or to specify both operands of a binary operator such as the <literal>=</literal> + equal sign. The latter restriction is necessary because it would be impossible + to determine the parameter type. In general, parameters are legal only in Data + Manipulation Languange (DML) statements, and not in Data Defination Language + (DDL) statements. + </para> + </note> + <para> + The parameter markers must be bound to application variables using + <function>maxdb_stmt_bind_param</function> and/or <function>maxdb_stmt_bind_result</function> + before executing the statement or fetching rows. + </para> + </refsect1> + <refsect1> + &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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -119,17 +117,17 @@ /* close statement */ $stmt->close(); -} +} /* close connection */ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -162,24 +160,24 @@ /* close statement */ maxdb_stmt_close($stmt); -} +} /* close connection */ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Portland is in district OR ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_stmt_reset</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <methodsynopsis> - <type>bool</type> - <methodname>reset</methodname> - <void /> - </methodsynopsis> - </classsynopsis> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_stmt_reset</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <methodsynopsis> + <type>bool</type><methodname>reset</methodname> + <void /> + </methodsynopsis> + </classsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>resource</type><methodname>maxdb_stmt_result_metadata</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <methodsynopsis> - <type>resource</type><methodname>result_metadata</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - If a statement passed to <function>maxdb_prepare</function> is one that produces - a result set, <function>maxdb_stmt_result_metadata</function> returns the result resource - that can be used to process the meta information such as total number of fields - and individual field information. - </para> - <note> - <para>This result set pointer can be passed as an argument to any of the - field-based functions that process result set metadata, such as: - <itemizedlist> - <listitem><para><function>maxdb_num_fields</function></para></listitem> - <listitem><para><function>maxdb_fetch_field</function></para></listitem> - <listitem><para><function>maxdb_fetch_field_direct</function></para></listitem> - <listitem><para><function>maxdb_fetch_fields</function></para></listitem> - <listitem><para><function>maxdb_field_count</function></para></listitem> - <listitem><para><function>maxdb_field_seek</function></para></listitem> - <listitem><para><function>maxdb_field_tell</function></para></listitem> - <listitem><para><function>maxdb_free_result</function></para></listitem> - </itemizedlist> - </para> - </note> - <para> - The result set structure should be freed when you are done with it, - which you can do by passing it to <function>maxdb_free_result</function> - </para> - <note> - <para> - The result set returned by <function>maxdb_stmt_result_metadata</function> contains only - metadata. It does not contain any row results. The rows are obtained by using the - statement handle with <function>maxdb_fetch</function>. - </para> - </note> - </refsect1> - <refsect1> - &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> - <para> - <example> - <title>Object oriented style</title> - <programlisting role='php'> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>resource</type><methodname>maxdb_stmt_result_metadata</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <methodsynopsis> + <type>resource</type><methodname>result_metadata</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + If a statement passed to <function>maxdb_prepare</function> is one that produces + a result set, <function>maxdb_stmt_result_metadata</function> returns the result resource + that can be used to process the meta information such as total number of fields + and individual field information. + </para> + <note> + <para>This result set pointer can be passed as an argument to any of the + field-based functions that process result set metadata, such as: + <itemizedlist> + <listitem><para><function>maxdb_num_fields</function></para></listitem> + <listitem><para><function>maxdb_fetch_field</function></para></listitem> + <listitem><para><function>maxdb_fetch_field_direct</function></para></listitem> + <listitem><para><function>maxdb_fetch_fields</function></para></listitem> + <listitem><para><function>maxdb_field_count</function></para></listitem> + <listitem><para><function>maxdb_field_seek</function></para></listitem> + <listitem><para><function>maxdb_field_tell</function></para></listitem> + <listitem><para><function>maxdb_free_result</function></para></listitem> + </itemizedlist> + </para> + </note> + <para> + The result set structure should be freed when you are done with it, + which you can do by passing it to <function>maxdb_free_result</function> + </para> + <note> + <para> + The result set returned by <function>maxdb_stmt_result_metadata</function> contains only + metadata. It does not contain any row results. The rows are obtained by using the + statement handle with <function>maxdb_fetch</function>. + </para> + </note> + </refsect1> + <refsect1> + &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> + <para> + <example> + <title>Object oriented style</title> + <programlisting role='php'> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); -$maxdb->query("CREATE TABLE temp.friends (id int, name varchar(20))"); - +$maxdb->query("CREATE TABLE temp.friends (id int, name varchar(20))"); + $maxdb->query("INSERT INTO temp.friends VALUES (1,'Hartmut')"); $maxdb->query("INSERT INTO temp.friends VALUES (2, 'Ulf')"); @@ -100,17 +100,17 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role='php'> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role='php'> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); -maxdb_query($link, "CREATE TABLE temp.friends (id int, name varchar(20))"); - +maxdb_query($link, "CREATE TABLE temp.friends (id int, name varchar(20))"); + maxdb_query($link, "INSERT INTO temp.friends VALUES (1,'Hartmut')"); maxdb_query($link, "INSERT INTO temp.friends VALUES (2, 'Ulf')"); @@ -132,19 +132,19 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - </para> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + </para> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Fieldname: ID ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_stmt_send_long_data</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - <methodparam><type>int</type><parameter>param_nr</parameter></methodparam> - <methodparam><type>string</type><parameter>data</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method)</para> - <classsynopsis> - <ooclass><classname>stmt</classname></ooclass> - <methodsynopsis> - <type>bool</type><methodname>stmt_send_long_data</methodname> - <methodparam><type>int</type><parameter>param_nr</parameter></methodparam> - <methodparam><type>string</type><parameter>data</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - Allows to send parameter data to the server in pieces (or chunks). - This function can be called multiple times to send the parts of a character or - binary data value for a column, which must be one of the TEXT or BLOB datatypes. - </para> - <para> - <parameter>param_nr</parameter> indicates which parameter to associate the data with. - Parameters are numbered beginning with 0. - <parameter>data</parameter> is a string containing data to be sent. - </para> - <note> - <para> - For efficiency reasons, this function should be used after calling - <function>maxdb_execute</function>. In this case, the data is not stored - on the client side. The end of the sequence must end with a call - to <function>maxdb_stmt_close_long_data</function>. - </para> - </note> - </refsect1> - <refsect1> - &reftitle.returnvalues; - <para>&return.success;</para> - </refsect1> - <refsect1> - &reftitle.seealso; - <para> - <function>maxdb_prepare</function>, - <function>maxdb_stmt_bind_param</function> - </para> - </refsect1> - </refentry> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_stmt_send_long_data</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam><type>int</type><parameter>param_nr</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method)</para> + <classsynopsis> + <ooclass><classname>stmt</classname></ooclass> + <methodsynopsis> + <type>bool</type><methodname>stmt_send_long_data</methodname> + <methodparam><type>int</type><parameter>param_nr</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + Allows to send parameter data to the server in pieces (or chunks). + This function can be called multiple times to send the parts of a character or + binary data value for a column, which must be one of the TEXT or BLOB datatypes. + </para> + <para> + <parameter>param_nr</parameter> indicates which parameter to associate the data with. + Parameters are numbered beginning with 0. + <parameter>data</parameter> is a string containing data to be sent. + </para> + <note> + <para> + For efficiency reasons, this function should be used after calling + <function>maxdb_execute</function>. In this case, the data is not stored + on the client side. The end of the sequence must end with a call + to <function>maxdb_stmt_close_long_data</function>. + </para> + </note> + </refsect1> + <refsect1> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1> + &reftitle.seealso; + <para> + <function>maxdb_prepare</function>, + <function>maxdb_stmt_bind_param</function> + </para> + </refsect1> +</refentry>  - <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> - <methodsynopsis> - <type>string</type><methodname>maxdb_stmt_sqlstate</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - </methodsynopsis> - <para> - Returns a string containing the SQLSTATE error code - for the most recently invoked prepared statement function that can succeed or fail. - The error code consists of five characters. <literal>'00000'</literal> means no error. - The values are specified by ANSI SQL and ODBC. - </para> - <note> - <para> - Note that not all MaxDB errors are yet mapped to SQLSTATE's. - The value <literal>HY000</literal> (general error) is used for unmapped errors. - </para> - </note> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <methodsynopsis> + <type>string</type><methodname>maxdb_stmt_sqlstate</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> + <para> + Returns a string containing the SQLSTATE error code + for the most recently invoked prepared statement function that can succeed or fail. + The error code consists of five characters. <literal>'00000'</literal> means no error. + The values are specified by ANSI SQL and ODBC. + </para> + <note> + <para> + Note that not all MaxDB errors are yet mapped to SQLSTATE's. + The value <literal>HY000</literal> (general error) is used for unmapped errors. + </para> + </note> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php /* Open a connection */ $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -76,17 +76,17 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php /* Open a connection */ $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -114,19 +114,19 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Warning: maxdb_stmt_execute(): -4004 POS(23) Unknown table name:MYCITY [42000] <...> Error: 42000. ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_stmt_store_result</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>object</type> - <methodname>store_result</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - <function>maxdb_stmt_store_result</function> has no functionally effect - and should not be used for retrieving data from MaxDB server. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_stmt_store_result</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>object</type> + <methodname>store_result</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + <function>maxdb_stmt_store_result</function> has no functionally effect + and should not be used for retrieving data from MaxDB server. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php /* Open a connection */ $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -77,17 +79,17 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php /* Open a connection */ $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); -/* check connection */ +/* check connection */ if (maxdb_connect_errno()) { printf("Connect failed: %s\n", maxdb_connect_error()); exit(); @@ -115,18 +117,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Number of rows: 25. ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>resource</type><methodname>maxdb_store_result</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>object</type> - <methodname>store_result</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - This function has no functionally effect. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <para> - See <function>maxdb_multi_query</function>. - </para> - </refsect1> - </refentry> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>resource</type><methodname>maxdb_store_result</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>object</type> + <methodname>store_result</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + This function has no functionally effect. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <para> + See <function>maxdb_multi_query</function>. + </para> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>int</type><methodname>maxdb_thread_id</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <fieldsynopsis><type>int</type><varname>thread_id</varname></fieldsynopsis> - </classsynopsis> - <para> - The <function>maxdb_thread_id</function> function returns the thread - ID for the current connection which can then be killed using the - <function>maxdb_kill</function> function. If the connection is lost - and you reconnect with <function>maxdb_ping</function>, the thread ID - will be other. Therefore you should get the thread ID only when you need it. - </para> - <note> - <para> - The thread ID is assigned on a connection-by-connection basis. Hence, - if the connection is broken and then re-established a new thread ID - will be assigned. - </para> - </note> - </refsect1> - <refsect1> - <title>Return values</title> - <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> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>int</type><methodname>maxdb_thread_id</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <fieldsynopsis><type>int</type><varname>thread_id</varname></fieldsynopsis> + </classsynopsis> + <para> + The <function>maxdb_thread_id</function> function returns the thread + ID for the current connection which can then be killed using the + <function>maxdb_kill</function> function. If the connection is lost + and you reconnect with <function>maxdb_ping</function>, the thread ID + will be other. Therefore you should get the thread ID only when you need it. + </para> + <note> + <para> + The thread ID is assigned on a connection-by-connection basis. Hence, + if the connection is broken and then re-established a new thread ID + will be assigned. + </para> + </note> + </refsect1> + <refsect1> + <title>Return values</title> + <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> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -76,11 +76,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -107,19 +107,19 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Warning: maxdb_query(): -10821 Session not connected <...> Error: Session not connected ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <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> - <para>Procedural style:</para> - <methodsynopsis> - <type>bool</type><methodname>maxdb_thread_safe</methodname> - <void /> - </methodsynopsis> - <para> - <function>maxdb_thread_safe</function> indicates whether the - client library is compiled as thread-safe. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <para> - &true; if the client library is thread-safe, otherwise &false;. - </para> - </refsect1> - </refentry> + +<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> + <para>Procedural style:</para> + <methodsynopsis> + <type>bool</type><methodname>maxdb_thread_safe</methodname> + <void /> + </methodsynopsis> + <para> + <function>maxdb_thread_safe</function> indicates whether the + client library is compiled as thread-safe. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + &true; if the client library is thread-safe, otherwise &false;. + </para> + </refsect1> +</refentry>  - <refentry id="function.maxdb-use-result"> - <refnamediv> - <refname>maxdb_use_result</refname> - <refname>maxdb->use_result</refname> - <refpurpose>Initiate a result set retrieval</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para>Procedural style:</para> - <methodsynopsis> - <type>resource</type><methodname>maxdb_use_result</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (method):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <methodsynopsis> - <type>resource</type><methodname>use_result</methodname> - <void /> - </methodsynopsis> - </classsynopsis> - <para> - <function>maxdb_use_result</function> has no effect. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <para> - Returns result or &false; in case of error. - </para> - </refsect1> - <refsect1> - <title>See also</title> - <para> - <function>maxdb_real_query</function>, - <function>maxdb_store_result</function>. - </para> - </refsect1> - <refsect1> - <title>Example</title> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<refentry id="function.maxdb-use-result"> + <refnamediv> + <refname>maxdb_use_result</refname> + <refname>maxdb->use_result</refname> + <refpurpose>Initiate a result set retrieval</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para>Procedural style:</para> + <methodsynopsis> + <type>resource</type><methodname>maxdb_use_result</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (method):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <methodsynopsis> + <type>resource</type><methodname>use_result</methodname> + <void /> + </methodsynopsis> + </classsynopsis> + <para> + <function>maxdb_use_result</function> has no effect. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + Returns result or &false; in case of error. + </para> + </refsect1> + <refsect1> + <title>See also</title> + <para> + <function>maxdb_real_query</function>, + <function>maxdb_store_result</function>. + </para> + </refsect1> + <refsect1> + <title>Example</title> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -76,11 +76,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -114,18 +114,18 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ a ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry>  - <refentry id="function.maxdb-warning-count"> - <refnamediv> - <refname>maxdb_warning_count</refname> - <refname>maxdb->warning_count</refname> - <refpurpose>Returns the number of warnings from the last query for the given link</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para>Procedural style:</para> - <methodsynopsis> - <type>int</type><methodname>maxdb_warning_count</methodname> - <methodparam><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para>Object oriented style (property):</para> - <classsynopsis> - <ooclass><classname>maxdb</classname></ooclass> - <fieldsynopsis><type>int</type><varname>warning_count</varname></fieldsynopsis> - </classsynopsis> - <para> - <function>maxdb_warning_count</function> returns the number of warnings - from the last query in the connection represented by the - <parameter>link</parameter> parameter. - </para> - </refsect1> - <refsect1> - <title>Return values</title> - <para> - Number of warnings or zero if there are no warnings. - </para> - </refsect1> - <refsect1> - <title>See also</title> - <para> - <function>maxdb_errno</function>, - <function>maxdb_error</function>, - <function>maxdb_sqlstate</function> - </para> - </refsect1> - <refsect1> - <title>Example</title> - <example> - <title>Object oriented style</title> - <programlisting role="php"> + +<refentry id="function.maxdb-warning-count"> + <refnamediv> + <refname>maxdb_warning_count</refname> + <refname>maxdb->warning_count</refname> + <refpurpose>Returns the number of warnings from the last query for the given link</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para>Procedural style:</para> + <methodsynopsis> + <type>int</type><methodname>maxdb_warning_count</methodname> + <methodparam><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para>Object oriented style (property):</para> + <classsynopsis> + <ooclass><classname>maxdb</classname></ooclass> + <fieldsynopsis><type>int</type><varname>warning_count</varname></fieldsynopsis> + </classsynopsis> + <para> + <function>maxdb_warning_count</function> returns the number of warnings + from the last query in the connection represented by the + <parameter>link</parameter> parameter. + </para> + </refsect1> + <refsect1> + <title>Return values</title> + <para> + Number of warnings or zero if there are no warnings. + </para> + </refsect1> + <refsect1> + <title>See also</title> + <para> + <function>maxdb_errno</function>, + <function>maxdb_error</function>, + <function>maxdb_sqlstate</function> + </para> + </refsect1> + <refsect1> + <title>Example</title> + <example> + <title>Object oriented style</title> + <programlisting role="php"> <![CDATA[ <?php $maxdb = new maxdb("localhost", "MONA", "RED", "DEMODB"); @@ -67,11 +67,11 @@ $maxdb->close(); ?> ]]> - </programlisting> - </example> - <example> - <title>Procedural style</title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ <?php $link = maxdb_connect("localhost", "MONA", "RED", "DEMODB"); @@ -96,19 +96,19 @@ maxdb_close($link); ?> ]]> - </programlisting> - </example> - <para> - The above examples would produce the following output: - </para> - <screen> + </programlisting> + </example> + <para> + The above examples would produce the following output: + </para> + <screen> <![CDATA[ Warning: maxdb_query(): -8004 POS(62) Constant must be compatible with column type and length <...> Number of warning: 0 ]]> - </screen> - </refsect1> - </refentry> + </screen> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: