betz Wed Apr 24 18:24:12 2002 EDT
Modified files:
/phpdoc/en/reference/dbplus constants.xml
Log:
corrections: include info from refernce.xml, thanks to Goba
Index: phpdoc/en/reference/dbplus/constants.xml
diff -u phpdoc/en/reference/dbplus/constants.xml:1.2
phpdoc/en/reference/dbplus/constants.xml:1.3
--- phpdoc/en/reference/dbplus/constants.xml:1.2 Tue Apr 23 10:44:48 2002
+++ phpdoc/en/reference/dbplus/constants.xml Wed Apr 24 18:24:11 2002
@@ -1,440 +1,349 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<section id="dbplus.constants">
&reftitle.constants;
- &extension.constants;
- <variablelist>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_NOERR</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_DUPLICATE</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_EOSCAN</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_EMPTY</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_CLOSE</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_WLOCKED</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_LOCKED</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_NOLOCK</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_READ</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_WRITE</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_CREATE</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_LSEEK</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_LENGTH</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_OPEN</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_WOPEN</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_MAGIC</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_VERSION</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_PGSIZE</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_CRC</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_PIPE</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_NIDX</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_MALLOC</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_NUSERS</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_PREEXIT</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_ONTRAP</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_PREPROC</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_DBPARSE</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_DBRUNERR</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_DBPREEXIT</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_WAIT</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_CORRUPT_TUPLE</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_WARNING0</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_PANIC</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_FIFO</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_PERM</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_TCL</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_RESTRICTED</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_USER</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>DBPLUS_ERR_UNKNOWN</constant>
- (<link linkend="language.types.integer">integer</link>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-</section>
+ &extension.constants;
+ <section id="dbplus.errorcodes">
+ <title>db++ error codes</title>
+ <para>
+ <table>
+ <title>DB++ Error Codes</title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>PHP Constant</entry>
+ <entry>db++ constant</entry>
+ <entry>meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-noerr'>DBPLUS_ERR_NOERR</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_NOERR</entry>
+ <entry>Null error condition</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-duplicate'>DBPLUS_ERR_DUPLICATE</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_DUPLICATE</entry>
+ <entry>Tried to insert a duplicate tuple</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-eoscan'>DBPLUS_ERR_EOSCAN</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_EOSCAN</entry>
+ <entry>End of scan from rget()</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-empty'>DBPLUS_ERR_EMPTY</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_EMPTY</entry>
+ <entry>Relation is empty (server)</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-close'>DBPLUS_ERR_CLOSE</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_CLOSE</entry>
+ <entry>The server can't close</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-wlocked'>DBPLUS_ERR_WLOCKED</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_WLOCKED</entry>
+ <entry>The record is write locked</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-locked'>DBPLUS_ERR_LOCKED</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_LOCKED</entry>
+ <entry>Relation was already locked</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-nolock'>DBPLUS_ERR_NOLOCK</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_NOLOCK</entry>
+ <entry>Relation cannot be locked</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-read'>DBPLUS_ERR_READ</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_READ</entry>
+ <entry>Read error on relation</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-write'>DBPLUS_ERR_WRITE</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_WRITE</entry>
+ <entry>Write error on relation</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-create'>DBPLUS_ERR_CREATE</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_CREATE</entry>
+ <entry>Create() system call failed</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-lseek'>DBPLUS_ERR_LSEEK</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_LSEEK</entry>
+ <entry>Lseek() system call failed</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-length'>DBPLUS_ERR_LENGTH</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_LENGTH</entry>
+ <entry>Tuple exceeds maximum length</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-open'>DBPLUS_ERR_OPEN</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_OPEN</entry>
+ <entry>Open() system call failed</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-wopen'>DBPLUS_ERR_WOPEN</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_WOPEN</entry>
+ <entry>Relation already opened for writing</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-magic'>DBPLUS_ERR_MAGIC</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_MAGIC</entry>
+ <entry>File is not a relation</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-version'>DBPLUS_ERR_VERSION</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_VERSION</entry>
+ <entry>File is a very old relation</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-pgsize'>DBPLUS_ERR_PGSIZE</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_PGSIZE</entry>
+ <entry>Relation uses a different page size</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-crc'>DBPLUS_ERR_CRC</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_CRC</entry>
+ <entry>Invalid crc in the superpage</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-pipe'>DBPLUS_ERR_PIPE</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_PIPE</entry>
+ <entry>Piped relation requires lseek()</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-nidx'>DBPLUS_ERR_NIDX</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_NIDX</entry>
+ <entry>Too many secondary indices</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-malloc'>DBPLUS_ERR_MALLOC</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_MALLOC</entry>
+ <entry>Malloc() call failed</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-nusers'>DBPLUS_ERR_NUSERS</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_NUSERS</entry>
+ <entry>Error use of max users</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-preexit'>DBPLUS_ERR_PREEXIT</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_PREEXIT</entry>
+ <entry>Caused by invalid usage</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-ontrap'>DBPLUS_ERR_ONTRAP</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_ONTRAP</entry>
+ <entry>Caused by a signal</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-preproc'>DBPLUS_ERR_PREPROC</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_PREPROC</entry>
+ <entry>Error in the preprocessor</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-dbparse'>DBPLUS_ERR_DBPARSE</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_DBPARSE</entry>
+ <entry>Error in the parser</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-dbrunerr'>DBPLUS_ERR_DBRUNERR</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_DBRUNERR</entry>
+ <entry>Run error in db</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-dbpreexit'>DBPLUS_ERR_DBPREEXIT</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_DBPREEXIT</entry>
+ <entry>Exit condition caused by prexit() * procedure</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-wait'>DBPLUS_ERR_WAIT</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_WAIT</entry>
+ <entry>Wait a little (Simple only)</entry>
+ </row>
+ <row>
+ <entry>
+ <constant
+id='constant.dbplus-err-corrupt-tuple'>DBPLUS_ERR_CORRUPT_TUPLE</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_CORRUPT_TUPLE</entry>
+ <entry>A client sent a corrupt tuple</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-warning0'>DBPLUS_ERR_WARNING0</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_WARNING0</entry>
+ <entry>
+ The Simple routines encountered a non fatal error which was
+ corrected
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-panic'>DBPLUS_ERR_PANIC</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_PANIC</entry>
+ <entry>
+ The server should not really die but after a disaster
+ send ERR_PANIC to all its clients
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-fifo'>DBPLUS_ERR_FIFO</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_FIFO</entry>
+ <entry>Can't create a fifo</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-perm'>DBPLUS_ERR_PERM</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_PERM</entry>
+ <entry>Permission denied</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-tcl'>DBPLUS_ERR_TCL</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_TCL</entry>
+ <entry>TCL_error</entry>
+ </row>
+ <row>
+ <entry>
+ <constant
+id='constant.dbplus-err-restricted'>DBPLUS_ERR_RESTRICTED</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_RESTRICTED</entry>
+ <entry>Only two users</entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-user'>DBPLUS_ERR_USER</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_USER</entry>
+ <entry>
+ An error in the use of the library by an application
+ programmer
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <constant id='constant.dbplus-err-unknown'>DBPLUS_ERR_UNKNOWN</constant>
+ (<link linkend="language.types.integer">integer</link>)
+ </entry>
+ <entry>ERR_UNKNOWN</entry>
+ <entry></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ </section>
+ </section>
<!-- Keep this comment at the end of the file
Local variables:
@@ -456,4 +365,3 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-
