cvs: phpdoc /en/reference/ingres-ii/functions ingres-autocommit.xml ingres-close.xml ingres-commit.xml ingres-connect.xml ingres-cursor.xml
ingres-errno.xml ingres-error.xml ingres-errsqlstate.xml ingres-fetch-array.xml ingres-fetch-object.xml ingres-fetch-row.xml ingres-field-length.xml
ingres-field-name.xml ingres-field-nullable.xml ingres-field-precision.xml ingres-field-scale.xml ingres-field-type.xml ingres-num-fields.xml
ingres-num-rows.xml ingres-pconnect.xml ingres-query.xml ingres-rollback.xml

didou Sun Jun 10 19:07:03 2007 UTC Modified files: /phpdoc/en/reference/ingres-ii/functions ingres-autocommit.xml ingres-close.xml ingres-commit.xml ingres-connect.xml ingres-cursor.xml ingres-errno.xml ingres-error.xml ingres-errsqlstate.xml ingres-fetch-array.xml ingres-fetch-object.xml ingres-fetch-row.xml ingres-field-length.xml ingres-field-name.xml ingres-field-nullable.xml ingres-field-precision.xml ingres-field-scale.xml ingres-field-type.xml ingres-num-fields.xml ingres-num-rows.xml ingres-pconnect.xml ingres-query.xml ingres-rollback.xml Log: ref.ingres-ii: switch to new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-autocommit.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-autocommit.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-autocommit.xml:1.6 phpdoc/en/reference/ingres-ii/functions/ingres-autocommit.xml:1.7 --- phpdoc/en/reference/ingres-ii/functions/ingres-autocommit.xml:1.6 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-autocommit.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.ingres-autocommit"> <refnamediv> <refname>ingres_autocommit</refname> <refpurpose>Switch autocommit on or off</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ingres_autocommit</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> @@ -26,13 +26,43 @@ committed by the server, as if <function>ingres_commit</function> was called after every call to <function>ingres_query</function>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + The connection link identifier. If not specified, the last opened link + is used. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also - <function>ingres_query</function>, - <function>ingres_rollback</function>, and - <function>ingres_commit</function>. + &return.success; </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ingres_query</function></member> + <member><function>ingres_rollback</function></member> + <member><function>ingres_commit</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-close.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-close.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-close.xml:1.4 phpdoc/en/reference/ingres-ii/functions/ingres-close.xml:1.5 --- phpdoc/en/reference/ingres-ii/functions/ingres-close.xml:1.4 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-close.xml Sun Jun 10 19:07:03 2007 @@ -1,36 +1,62 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ingres-close"> <refnamediv> <refname>ingres_close</refname> <refpurpose>Close an Ingres II database connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ingres_close</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> </methodsynopsis> <para> - Returns &true; on success, or &false; on failure. - </para> - <para> <function>ingres_close</function> closes the connection to the Ingres server that's associated with the specified link. - If the <parameter>link</parameter> parameter isn't - specified, the last opened link is used. </para> <para> <function>ingres_close</function> isn't usually necessary, as it won't close persistent connections and all non-persistent connections are automatically closed at the end of the script. </para> - <para> See also - <function>ingres_connect</function> and - <function>ingres_pconnect</function>. + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + The connection link identifier. If not specified, the last opened link + is used. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ingres_connect</function></member> + <member><function>ingres_pconnect</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-commit.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-commit.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-commit.xml:1.5 phpdoc/en/reference/ingres-ii/functions/ingres-commit.xml:1.6 --- phpdoc/en/reference/ingres-ii/functions/ingres-commit.xml:1.5 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-commit.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ingres-commit"> <refnamediv> <refname>ingres_commit</refname> <refpurpose>Commit a transaction</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ingres_commit</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> @@ -25,13 +25,43 @@ query by calling <function>ingres_autocommit</function> before opening the transaction. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + The connection link identifier. If not specified, the last opened link + is used. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also - <function>ingres_query</function>, - <function>ingres_rollback</function>, and - <function>ingres_autocommit</function>. + &return.success; </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ingres_query</function></member> + <member><function>ingres_rollback</function></member> + <member><function>ingres_autocommit</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-connect.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-connect.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-connect.xml:1.7 phpdoc/en/reference/ingres-ii/functions/ingres-connect.xml:1.8 --- phpdoc/en/reference/ingres-ii/functions/ingres-connect.xml:1.7 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-connect.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.ingres-connect"> <refnamediv> <refname>ingres_connect</refname> <refpurpose>Open a connection to an Ingres database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ingres_connect</methodname> <methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam> @@ -16,16 +16,23 @@ <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> - Returns a Ingres link resource on success, or &false; on - failure. + <function>ingres_connect</function> opens a connection with the + given Ingres <parameter>database</parameter>. </para> <para> - <function>ingres_connect</function> opens a connection with the - Ingres database designated by <parameter>database</parameter>, - which follows the syntax - <parameter>[node_id::]dbname[/svr_class]</parameter>. + The connection is closed when the script ends or when + <function>ingres_close</function> is called on this link. </para> <para> + All the other ingres functions use the last opened link as a + default, so you need to store the returned value only if you use + more than one link at a time. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> If some parameters are missing, <function>ingres_connect</function> uses the values in &php.ini; for <parameter>ingres.default_database</parameter>, @@ -33,166 +40,202 @@ <parameter>ingres.default_password</parameter>. </para> <para> - The connection is closed when the script ends or when - <function>ingres_close</function> is called on this link. - </para> - <para> - All the other ingres functions use the last opened link as a - default, so you need to store the returned value only if you use - more than one link at a time. + <variablelist> + <varlistentry> + <term><parameter>database</parameter></term> + <listitem> + <para> + The database name. Must follows the syntax + <varname>[node_id::]dbname[/svr_class]</varname>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The Ingres user name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The password associated with <parameter>username</parameter>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + <function>ingres_connect</function> options + <informaltable> + <tgroup cols='2'> + <thead> + <row> + <entry>Option name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>date_century_boundary</entry> + <entry>The threshold by which a 2 digit year is determined to be in + the current century or in the next century. Equivalent to II_DATE_CENTURY_BOUNDARY. </entry> + </row> + <row> + <entry>group</entry> + <entry>Speficfies the group ID of the user, equivalent to the '-G' + flag</entry> + </row> + <row> + <entry>role</entry> + <entry>The role ID of the application. If a role password is + required, the parameter value should be specified as "role/password"</entry> + </row> + <row> + <entry>effective_user</entry> + <entry>The ingres user account being impersonated, equivalent to the '-u' flag</entry> + </row> + <row> + <entry>dbms_password</entry> + <entry>The internal database password for the user connecting to Ingres</entry> + </row> + <row> + <entry>table_structure</entry> + <entry>The default structure for new tables. Valid values for + table_structure are: + <itemizedlist> + <listitem><simpara>INGRES_STRUCTURE_BTREE</simpara></listitem> + <listitem><simpara>INGRES_STRUCTURE_HASH</simpara></listitem> + <listitem><simpara>INGRES_STRUCTURE_HEAP</simpara></listitem> + <listitem><simpara>INGRES_STRUCTURE_ISAM</simpara></listitem> + <listitem><simpara>INGRES_STRUCTURE_CBTREE</simpara></listitem> + <listitem><simpara>INGRES_STRUCTURE_CISAM</simpara></listitem> + <listitem><simpara>INGRES_STRUCTURE_CHASH</simpara></listitem> + <listitem><simpara>INGRES_STRUCTURE_CHEAP</simpara></listitem> + </itemizedlist> + </entry> + </row> + <row> + <entry>index_structure</entry> + <entry>The default structure for new secondary indexes. Valid values + for index_structure are: + <itemizedlist> + <listitem><simpara>INGRES_STRUCTURE_CBTREE</simpara></listitem> + <listitem><simpara>INGRES_STRUCTURE_CISAM</simpara></listitem> + <listitem><simpara>INGRES_STRUCTURE_CHASH</simpara></listitem> + <listitem><simpara>INGRES_STRUCTURE_BTREE</simpara></listitem> + <listitem><simpara>INGRES_STRUCTURE_HASH</simpara></listitem> + <listitem><simpara>INGRES_STRUCTURE_ISAM</simpara></listitem> + </itemizedlist> + </entry> + </row> + <row> + <entry>login_local</entry> + <entry>Determines how the connection user ID and password are + used when a VNODE is included in the target database string. + If set to TRUE, the user ID and password are used to locally access + the VNODE and the VNODE login information is used to establish the DBMS + connection. If set to FALSE, the process user ID is used to access + the VNODE and the connection user ID and password are used in place + of the VNODE login information to establish the DBMS connection. + This parameter is ignored if no VNODE is included in the target + database string. The default is FALSE.</entry> + </row> + <row> + <entry>timezone</entry> + <entry>Controls the timezone of the session. If not set it will + default the the value defined by II_TIMEZONE_NAME. If + II_TIMEZONE_NAME is not defined the NA-PACIFIC (GMT-8 with Daylight + Savings) is used.</entry> + </row> + <row> + <entry>date_format</entry> + <entry>Sets the allowable input and output format for Ingres dates. + Defaults to the value defined by II_DATE_FORMAT. If II_DATE_FORMAT is + not set the default date format is US, e.g. mm/dd/yy. Valid values + for date_format are: + <itemizedlist> + <listitem><simpara>INGRES_DATE_DMY</simpara></listitem> + <listitem><simpara>INGRES_DATE_FINISH</simpara></listitem> + <listitem><simpara>INGRES_DATE_GERMAN</simpara></listitem> + <listitem><simpara>INGRES_DATE_ISO</simpara></listitem> + <listitem><simpara>INGRES_DATE_ISO4</simpara></listitem> + <listitem><simpara>INGRES_DATE_MDY</simpara></listitem> + <listitem><simpara>INGRES_DATE_MULTINATIONAL</simpara></listitem> + <listitem><simpara>INGRES_DATE_MULTINATIONAL4</simpara></listitem> + <listitem><simpara>INGRES_DATE_YMD</simpara></listitem> + <listitem><simpara>INGRES_DATE_US</simpara></listitem> + </itemizedlist> + </entry> + </row> + <row> + <entry>decimal_separator</entry> + <entry>The character identifier for decimal data</entry> + </row> + <row> + <entry>money_lort</entry> + <entry>Leading or trailing currency sign. Valid values for money_lort + are: + <itemizedlist> + <listitem><simpara>INGRES_MONEY_LEADING</simpara></listitem> + <listitem><simpara>INGRES_MONEY_TRAILING</simpara></listitem> + </itemizedlist> + </entry> + </row> + <row> + <entry>money_sign</entry> + <entry>The currency symbol to be used with the MONEY datatype</entry> + </row> + <row> + <entry>money_precision</entry> + <entry>The precision of the MONEY datatype</entry> + </row> + <row> + <entry>float4_precision</entry> + <entry>Precision of the FLOAT4 datatype</entry> + </row> + <row> + <entry>float8_precision</entry> + <entry>Precision of the FLOAT8 data</entry> + </row> + <row> + <entry>blob_segment_length</entry> + <entry>The amount of data in bytes to fetch at a time when retrieving + BLOB/CLOB data, defaults to 4096 bytes when not explicitly set.</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>ingres_connect</function> options - <informaltable> - <tgroup cols='2'> - <thead> - <row> - <entry>Option name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>date_century_boundary</entry> - <entry>The threshold by which a 2 digit year is determined to be in - the current century or in the next century. Equivalent to II_DATE_CENTURY_BOUNDARY. </entry> - </row> - <row> - <entry>group</entry> - <entry>Speficfies the group ID of the user, equivalent to the '-G' - flag</entry> - </row> - <row> - <entry>role</entry> - <entry>The role ID of the application. If a role password is - required, the parameter value should be specified as "role/password"</entry> - </row> - <row> - <entry>effective_user</entry> - <entry>The ingres user account being impersonated, equivalent to the '-u' flag</entry> - </row> - <row> - <entry>dbms_password</entry> - <entry>The internal database password for the user connecting to Ingres</entry> - </row> - <row> - <entry>table_structure</entry> - <entry>The default structure for new tables. Valid values for - table_structure are: - <itemizedlist> - <listitem><simpara>INGRES_STRUCTURE_BTREE</simpara></listitem> - <listitem><simpara>INGRES_STRUCTURE_HASH</simpara></listitem> - <listitem><simpara>INGRES_STRUCTURE_HEAP</simpara></listitem> - <listitem><simpara>INGRES_STRUCTURE_ISAM</simpara></listitem> - <listitem><simpara>INGRES_STRUCTURE_CBTREE</simpara></listitem> - <listitem><simpara>INGRES_STRUCTURE_CISAM</simpara></listitem> - <listitem><simpara>INGRES_STRUCTURE_CHASH</simpara></listitem> - <listitem><simpara>INGRES_STRUCTURE_CHEAP</simpara></listitem> - </itemizedlist> - </entry> - </row> - <row> - <entry>index_structure</entry> - <entry>The default structure for new secondary indexes. Valid values - for index_structure are: - <itemizedlist> - <listitem><simpara>INGRES_STRUCTURE_CBTREE</simpara></listitem> - <listitem><simpara>INGRES_STRUCTURE_CISAM</simpara></listitem> - <listitem><simpara>INGRES_STRUCTURE_CHASH</simpara></listitem> - <listitem><simpara>INGRES_STRUCTURE_BTREE</simpara></listitem> - <listitem><simpara>INGRES_STRUCTURE_HASH</simpara></listitem> - <listitem><simpara>INGRES_STRUCTURE_ISAM</simpara></listitem> - </itemizedlist> - </entry> - </row> - <row> - <entry>login_local</entry> - <entry>Determines how the connection user ID and password are - used when a VNODE is included in the target database string. - If set to TRUE, the user ID and password are used to locally access - the VNODE and the VNODE login information is used to establish the DBMS - connection. If set to FALSE, the process user ID is used to access - the VNODE and the connection user ID and password are used in place - of the VNODE login information to establish the DBMS connection. - This parameter is ignored if no VNODE is included in the target - database string. The default is FALSE.</entry> - </row> - <row> - <entry>timezone</entry> - <entry>Controls the timezone of the session. If not set it will - default the the value defined by II_TIMEZONE_NAME. If - II_TIMEZONE_NAME is not defined the NA-PACIFIC (GMT-8 with Daylight - Savings) is used.</entry> - </row> - <row> - <entry>date_format</entry> - <entry>Sets the allowable input and output format for Ingres dates. - Defaults to the value defined by II_DATE_FORMAT. If II_DATE_FORMAT is - not set the default date format is US, e.g. mm/dd/yy. Valid values - for date_format are: - <itemizedlist> - <listitem><simpara>INGRES_DATE_DMY</simpara></listitem> - <listitem><simpara>INGRES_DATE_FINISH</simpara></listitem> - <listitem><simpara>INGRES_DATE_GERMAN</simpara></listitem> - <listitem><simpara>INGRES_DATE_ISO</simpara></listitem> - <listitem><simpara>INGRES_DATE_ISO4</simpara></listitem> - <listitem><simpara>INGRES_DATE_MDY</simpara></listitem> - <listitem><simpara>INGRES_DATE_MULTINATIONAL</simpara></listitem> - <listitem><simpara>INGRES_DATE_MULTINATIONAL4</simpara></listitem> - <listitem><simpara>INGRES_DATE_YMD</simpara></listitem> - <listitem><simpara>INGRES_DATE_US</simpara></listitem> - </itemizedlist> - </entry> - </row> - <row> - <entry>decimal_separator</entry> - <entry>The character identifier for decimal data</entry> - </row> - <row> - <entry>money_lort</entry> - <entry>Leading or trailing currency sign. Valid values for money_lort - are: - <itemizedlist> - <listitem><simpara>INGRES_MONEY_LEADING</simpara></listitem> - <listitem><simpara>INGRES_MONEY_TRAILING</simpara></listitem> - </itemizedlist> - </entry> - </row> - <row> - <entry>money_sign</entry> - <entry>The currency symbol to be used with the MONEY datatype</entry> - </row> - <row> - <entry>money_precision</entry> - <entry>The precision of the MONEY datatype</entry> - </row> - <row> - <entry>float4_precision</entry> - <entry>Precision of the FLOAT4 datatype</entry> - </row> - <row> - <entry>float8_precision</entry> - <entry>Precision of the FLOAT8 data</entry> - </row> - <row> - <entry>blob_segment_length</entry> - <entry>The amount of data in bytes to fetch at a time when retrieving - BLOB/CLOB data, defaults to 4096 bytes when not explicitly set.</entry> - </row> - </tbody> - </tgroup> - </informaltable> + Returns a Ingres link resource on success, or &false; on failure. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>ingres_connect</function> example</title> <programlisting role="php"> <![CDATA[ <?php - $link = ingres_connect("mydb", "user", "pass") - or die("Could not connect"); - echo "Connected successfully"; - ingres_close($link); +$link = ingres_connect("mydb", "user", "pass") + or die("Could not connect"); +echo "Connected successfully"; +ingres_close($link); ?> ]]> </programlisting> @@ -204,21 +247,27 @@ <programlisting role="php"> <![CDATA[ <?php - ingres_connect("mydb", "user", "pass") - or die("Could not connect"); - echo "Connected successfully"; - ingres_close(); +ingres_connect("mydb", "user", "pass") + or die("Could not connect"); +echo "Connected successfully"; +ingres_close(); ?> ]]> </programlisting> </example> </para> - <para> - See also - <function>ingres_pconnect</function> and - <function>ingres_close</function>. + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ingres_pconnect</function></member> + <member><function>ingres_close</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-cursor.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-cursor.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-cursor.xml:1.3 phpdoc/en/reference/ingres-ii/functions/ingres-cursor.xml:1.4 --- phpdoc/en/reference/ingres-ii/functions/ingres-cursor.xml:1.3 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-cursor.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ingres-cursor"> <refnamediv> <refname>ingres_cursor</refname> <refpurpose>Gets a cursor name for a given link resource</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ingres_cursor</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> @@ -23,6 +23,33 @@ <function>ingres_cursor</function> returns the cursor name asssociated with the default link. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + + </para> + </refsect1> + + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>ingres_cursor</function> example</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-errno.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-errno.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-errno.xml:1.4 phpdoc/en/reference/ingres-ii/functions/ingres-errno.xml:1.5 --- phpdoc/en/reference/ingres-ii/functions/ingres-errno.xml:1.4 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-errno.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ingres-errno"> <refnamediv> <refname>ingres_errno</refname> <refpurpose>Gets the last ingres error number generated</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ingres_errno</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> @@ -28,6 +28,33 @@ <function>ingres_errno</function> is called, will reset or change any error code from the last Ingres function call. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + + </para> + </refsect1> + + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>ingres_errno</function> example</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-error.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-error.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-error.xml:1.2 phpdoc/en/reference/ingres-ii/functions/ingres-error.xml:1.3 --- phpdoc/en/reference/ingres-ii/functions/ingres-error.xml:1.2 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-error.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ingres-error"> <refnamediv> <refname>ingres_error</refname> <refpurpose>Gets a meaningful error message for the last error generated</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ingres_error</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> @@ -28,6 +28,33 @@ <function>ingres_error</function> is called will reset or change any error message from the last Ingres function call. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + + </para> + </refsect1> + + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>ingres_error</function> example</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-errsqlstate.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-errsqlstate.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-errsqlstate.xml:1.3 phpdoc/en/reference/ingres-ii/functions/ingres-errsqlstate.xml:1.4 --- phpdoc/en/reference/ingres-ii/functions/ingres-errsqlstate.xml:1.3 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-errsqlstate.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ingres-errsqlstate"> <refnamediv> <refname>ingres_errsqlstate</refname> <refpurpose>Gets the last SQLSTATE error code generated</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ingres_errsqlstate</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> @@ -29,6 +29,33 @@ before <function>ingres_errsqlstate</function> is called will reset or change any error message from the last Ingres function call. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + + </para> + </refsect1> + + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>ingres_errsqlstate</function> example</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-fetch-array.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-fetch-array.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-fetch-array.xml:1.7 phpdoc/en/reference/ingres-ii/functions/ingres-fetch-array.xml:1.8 --- phpdoc/en/reference/ingres-ii/functions/ingres-fetch-array.xml:1.7 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-fetch-array.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.ingres-fetch-array"> <refnamediv> <refname>ingres_fetch_array</refname> <refpurpose>Fetch a row of result into an array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>ingres_fetch_array</methodname> <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> @@ -56,6 +56,40 @@ <function>ingres_fetch_row</function> (the difference is insignificant). </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result_type</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + + </para> + </refsect1> + + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>ingres_fetch_array</function> example</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-fetch-object.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-fetch-object.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-fetch-object.xml:1.6 phpdoc/en/reference/ingres-ii/functions/ingres-fetch-object.xml:1.7 --- phpdoc/en/reference/ingres-ii/functions/ingres-fetch-object.xml:1.6 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-fetch-object.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.ingres-fetch-object"> <refnamediv> <refname>ingres_fetch_object</refname> <refpurpose>Fetch a row of result into an object</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>object</type><methodname>ingres_fetch_object</methodname> <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> @@ -36,6 +36,40 @@ <function>ingres_fetch_row</function> (the difference is insignificant). </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result_type</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + + </para> + </refsect1> + + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>ingres_fetch_object</function> example</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-fetch-row.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-fetch-row.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-fetch-row.xml:1.5 phpdoc/en/reference/ingres-ii/functions/ingres-fetch-row.xml:1.6 --- phpdoc/en/reference/ingres-ii/functions/ingres-fetch-row.xml:1.5 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-fetch-row.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ingres-fetch-row"> <refnamediv> <refname>ingres_fetch_row</refname> <refpurpose>Fetch a row of result into an enumerated array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>ingres_fetch_row</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> @@ -23,6 +23,33 @@ return the next row in the result set, or &false; if there are no more rows. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + + </para> + </refsect1> + + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>ingres_fetch_row</function> example</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-field-length.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-field-length.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-field-length.xml:1.4 phpdoc/en/reference/ingres-ii/functions/ingres-field-length.xml:1.5 --- phpdoc/en/reference/ingres-ii/functions/ingres-field-length.xml:1.4 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-field-length.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ingres-field-length"> <refnamediv> <refname>ingres_field_length</refname> <refpurpose>Get the length of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ingres_field_length</methodname> <methodparam><type>int</type><parameter>index</parameter></methodparam> @@ -32,6 +32,36 @@ <function>ingres_fetch_row</function>. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>index</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-field-name.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-field-name.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-field-name.xml:1.5 phpdoc/en/reference/ingres-ii/functions/ingres-field-name.xml:1.6 --- phpdoc/en/reference/ingres-ii/functions/ingres-field-name.xml:1.5 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-field-name.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ingres-field-name"> <refnamediv> <refname>ingres_field_name</refname> <refpurpose>Get the name of a field in a query result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ingres_field_name</methodname> <methodparam><type>int</type><parameter>index</parameter></methodparam> @@ -30,6 +30,36 @@ <function>ingres_fetch_row</function>. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>index</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-field-nullable.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-field-nullable.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-field-nullable.xml:1.4 phpdoc/en/reference/ingres-ii/functions/ingres-field-nullable.xml:1.5 --- phpdoc/en/reference/ingres-ii/functions/ingres-field-nullable.xml:1.4 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-field-nullable.xml Sun Jun 10 19:07:03 2007 @@ -1,35 +1,70 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ingres-field-nullable"> <refnamediv> <refname>ingres_field_nullable</refname> <refpurpose>Test if a field is nullable</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ingres_field_nullable</methodname> <methodparam><type>int</type><parameter>index</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> </methodsynopsis> <para> - <function>ingres_field_nullable</function> returns &true; if the - field can be set to the &null; value and &false; if it can't. + Test if a field is nullable. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>index</parameter> is the number of the field and must - be between 1 and the value given by - <function>ingres_num_fields</function>. + <variablelist> + <varlistentry> + <term><parameter>index</parameter></term> + <listitem> + <para> + <parameter>index</parameter> is the number of the field and must + be between 1 and the value given by + <function>ingres_num_fields</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + The connection link identifier. If not specified, the last opened link + is used. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also - <function>ingres_query</function>, - <function>ingres_fetch_array</function>, - <function>ingres_fetch_object</function>, and - <function>ingres_fetch_row</function>. + <function>ingres_field_nullable</function> returns &true; if the + field can be set to the &null; value and &false; if it can't. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ingres_query</function></member> + <member><function>ingres_fetch_array</function></member> + <member><function>ingres_fetch_object</function></member> + <member><function>ingres_fetch_row</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-field-precision.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-field-precision.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-field-precision.xml:1.4 phpdoc/en/reference/ingres-ii/functions/ingres-field-precision.xml:1.5 --- phpdoc/en/reference/ingres-ii/functions/ingres-field-precision.xml:1.4 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-field-precision.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ingres-field-precision"> <refnamediv> <refname>ingres_field_precision</refname> <refpurpose>Get the precision of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ingres_field_precision</methodname> <methodparam><type>int</type><parameter>index</parameter></methodparam> @@ -19,19 +19,54 @@ SQL data types. For detailed information, see the Ingres/OpenAPI User Guide - Appendix C. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>index</parameter> is the number of the field and must - be between 1 and the value given by - <function>ingres_num_fields</function>. + <variablelist> + <varlistentry> + <term><parameter>index</parameter></term> + <listitem> + <para> + <parameter>index</parameter> is the number of the field and must + be between 1 and the value given by + <function>ingres_num_fields</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + The connection link identifier. If not specified, the last opened link + is used. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also - <function>ingres_query</function>, - <function>ingres_fetch_array</function>, - <function>ingres_fetch_object</function>, and - <function>ingres_fetch_row</function>. + Returns the field precision as an integer. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ingres_query</function></member> + <member><function>ingres_fetch_array</function></member> + <member><function>ingres_fetch_object</function></member> + <member><function>ingres_fetch_row</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-field-scale.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-field-scale.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-field-scale.xml:1.4 phpdoc/en/reference/ingres-ii/functions/ingres-field-scale.xml:1.5 --- phpdoc/en/reference/ingres-ii/functions/ingres-field-scale.xml:1.4 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-field-scale.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ingres-field-scale"> <refnamediv> <refname>ingres_field_scale</refname> <refpurpose>Get the scale of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ingres_field_scale</methodname> <methodparam><type>int</type><parameter>index</parameter></methodparam> @@ -19,19 +19,54 @@ type. For detailed information, see the Ingres/OpenAPI User Guide - Appendix C. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>index</parameter> is the number of the field and must - be between 1 and the value given by - <function>ingres_num_fields</function>. + <variablelist> + <varlistentry> + <term><parameter>index</parameter></term> + <listitem> + <para> + <parameter>index</parameter> is the number of the field and must + be between 1 and the value given by + <function>ingres_num_fields</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + The connection link identifier. If not specified, the last opened link + is used. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also - <function>ingres_query</function>, - <function>ingres_fetch_array</function>, - <function>ingres_fetch_object</function>, and - <function>ingres_fetch_row</function>. + Returns the scale of the field, as an integer. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ingres_query</function></member> + <member><function>ingres_fetch_array</function></member> + <member><function>ingres_fetch_object</function></member> + <member><function>ingres_fetch_row</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-field-type.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-field-type.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-field-type.xml:1.4 phpdoc/en/reference/ingres-ii/functions/ingres-field-type.xml:1.5 --- phpdoc/en/reference/ingres-ii/functions/ingres-field-type.xml:1.4 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-field-type.xml Sun Jun 10 19:07:03 2007 @@ -1,19 +1,53 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ingres-field-type"> <refnamediv> <refname>ingres_field_type</refname> <refpurpose>Get the type of a field in a query result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ingres_field_type</methodname> <methodparam><type>int</type><parameter>index</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> </methodsynopsis> <para> + Get the type of a field in a query result. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>index</parameter></term> + <listitem> + <para> + <parameter>index</parameter> is the number of the field and must + be between 1 and the value given by + <function>ingres_num_fields</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + The connection link identifier. If not specified, the last opened link + is used. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> <function>ingres_field_type</function> returns the type of a field in a query result, or &false; on failure. Examples of types returned are "IIAPI_BYTE_TYPE", "IIAPI_CHA_TYPE", @@ -24,19 +58,20 @@ "IIAPI_FLT_TYPE" can be a float4 or a float8. For detailed information, see the Ingres/OpenAPI User Guide - Appendix C. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - <parameter>index</parameter> is the number of the field and must - be between 1 and the value given by - <function>ingres_num_fields</function>. - </para> - <para> - See also - <function>ingres_query</function>, - <function>ingres_fetch_array</function>, - <function>ingres_fetch_object</function>, and - <function>ingres_fetch_row</function>. + <simplelist> + <member><function>ingres_query</function></member> + <member><function>ingres_fetch_array</function></member> + <member><function>ingres_fetch_object</function></member> + <member><function>ingres_fetch_row</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-num-fields.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-num-fields.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-num-fields.xml:1.4 phpdoc/en/reference/ingres-ii/functions/ingres-num-fields.xml:1.5 --- phpdoc/en/reference/ingres-ii/functions/ingres-num-fields.xml:1.4 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-num-fields.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ingres-num-fields"> <refnamediv> <refname>ingres_num_fields</refname> <refpurpose>Get the number of fields returned by the last query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ingres_num_fields</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> @@ -17,14 +17,44 @@ fields in the results returned by the Ingres server after a call to <function>ingres_query</function> </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + The connection link identifier. If not specified, the last opened link + is used. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also - <function>ingres_query</function>, - <function>ingres_fetch_array</function>, - <function>ingres_fetch_object</function>, and - <function>ingres_fetch_row</function>. + Returns the number of fields. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ingres_query</function></member> + <member><function>ingres_fetch_array</function></member> + <member><function>ingres_fetch_object</function></member> + <member><function>ingres_fetch_row</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-num-rows.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-num-rows.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-num-rows.xml:1.4 phpdoc/en/reference/ingres-ii/functions/ingres-num-rows.xml:1.5 --- phpdoc/en/reference/ingres-ii/functions/ingres-num-rows.xml:1.4 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-num-rows.xml Sun Jun 10 19:07:03 2007 @@ -1,49 +1,72 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ingres-num-rows"> <refnamediv> <refname>ingres_num_rows</refname> <refpurpose>Get the number of rows affected or returned by the last query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ingres_num_rows</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> </methodsynopsis> <para> + This function is mainly meant to get the number of rows + modified in the database. If this function is called before + using <function>ingres_fetch_array</function>, + <function>ingres_fetch_object</function> or + <function>ingres_fetch_row</function> the server will delete + the result's data and the script won't be able to get them. + </para> + <para> + You should instead retrieve the result's data using one of + these fetch functions in a loop until it returns &false;, + indicating that no more results are available. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + The connection link identifier. If not specified, the last opened link + is used. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> For delete, insert or update queries, <function>ingres_num_rows</function> returns the number of rows affected by the query. For other queries, <function>ingres_num_rows</function> returns the number of rows in the query's result. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - <note> - <simpara> - This function is mainly meant to get the number of rows - modified in the database. If this function is called before - using <function>ingres_fetch_array</function>, - <function>ingres_fetch_object</function> or - <function>ingres_fetch_row</function> the server will delete - the result's data and the script won't be able to get them. - </simpara> - <simpara> - You should instead retrieve the result's data using one of - these fetch functions in a loop until it returns &false;, - indicating that no more results are available. - </simpara> - </note> - </para> - <para> - See also - <function>ingres_query</function>, - <function>ingres_fetch_array</function>, - <function>ingres_fetch_object</function>, and - <function>ingres_fetch_row</function>. + <simplelist> + <member><function>ingres_query</function></member> + <member><function>ingres_fetch_array</function></member> + <member><function>ingres_fetch_object</function></member> + <member><function>ingres_fetch_row</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-pconnect.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-pconnect.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-pconnect.xml:1.4 phpdoc/en/reference/ingres-ii/functions/ingres-pconnect.xml:1.5 --- phpdoc/en/reference/ingres-ii/functions/ingres-pconnect.xml:1.4 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-pconnect.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ingres-pconnect"> <refnamediv> <refname>ingres_pconnect</refname> <refpurpose>Open a persistent connection to an Ingres II database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ingres_pconnect</methodname> <methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam> @@ -15,13 +15,10 @@ <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> </methodsynopsis> <para> - Returns a Ingres II link resource on success, or &false; on - failure. + Open a persistent connection to an Ingres II database. </para> <para> - See <function>ingres_connect</function> for parameters details - and examples. There are only 2 differences between - <function>ingres_pconnect</function> and + There are only 2 differences between this function and <function>ingres_connect</function> : First, when connecting, the function will first try to find a (persistent) link that's already opened with the same parameters. If one is found, an @@ -33,11 +30,58 @@ established by <function>ingres_pconnect</function>). This type of link is therefore called 'persistent'. </para> - <para> See also - <function>ingres_connect</function> and - <function>ingres_close</function>. + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>database</parameter></term> + <listitem> + <para> + The database name. Must follows the syntax + <varname>[node_id::]dbname[/svr_class]</varname>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The Ingres user name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The password associated with <parameter>username</parameter>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a Ingres II link resource on success, or &false; on failure. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ingres_connect</function></member> + <member><function>ingres_close</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-query.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-query.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-query.xml:1.6 phpdoc/en/reference/ingres-ii/functions/ingres-query.xml:1.7 --- phpdoc/en/reference/ingres-ii/functions/ingres-query.xml:1.6 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-query.xml Sun Jun 10 19:07:03 2007 @@ -1,25 +1,21 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.ingres-query"> <refnamediv> <refname>ingres_query</refname> <refpurpose>Send a SQL query to Ingres II</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ingres_query</methodname> <methodparam><type>string</type><parameter>query</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> </methodsynopsis> <para> - Returns &true; on success, or &false; on failure. - </para> - <para> <function>ingres_query</function> sends the given - <parameter>query</parameter> to the Ingres server. This query - must be a valid SQL query (see the Ingres SQL reference guide) + <parameter>query</parameter> to the Ingres server. </para> <para> The query becomes part of the currently open transaction. If @@ -33,51 +29,87 @@ <function>ingres_autocommit</function> before opening a new transaction to have every SQL query immediately committed. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Some types of SQL queries can't be sent with this function: - <itemizedlist> - <listitem> - <simpara> - close (see <function>ingres_close</function>) - </simpara> - </listitem> - <listitem> - <simpara> - commit (see <function>ingres_commit</function>) - </simpara> - </listitem> - <listitem> - <simpara> - connect (see <function>ingres_connect</function>) - </simpara> - </listitem> - <listitem> - <simpara> - disconnect (see <function>ingres_close</function>) - </simpara> - </listitem> - <listitem> - <simpara>get dbevent</simpara> - </listitem> - <listitem> - <simpara>prepare to commit</simpara> - </listitem> - <listitem> - <simpara> - rollback (see <function>ingres_rollback</function>) - </simpara> - </listitem> - <listitem><simpara>savepoint</simpara></listitem> - <listitem> - <simpara> - set autocommit (see <function>ingres_autocommit</function>) - </simpara> - </listitem> - <listitem> - <simpara>all cursor related queries are unsupported</simpara> - </listitem> - </itemizedlist> + <variablelist> + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + A valid SQL query (see the Ingres SQL reference guide). + </para> + <para> + Some types of SQL queries can't be sent with this function: + <itemizedlist> + <listitem> + <simpara> + close (see <function>ingres_close</function>) + </simpara> + </listitem> + <listitem> + <simpara> + commit (see <function>ingres_commit</function>) + </simpara> + </listitem> + <listitem> + <simpara> + connect (see <function>ingres_connect</function>) + </simpara> + </listitem> + <listitem> + <simpara> + disconnect (see <function>ingres_close</function>) + </simpara> + </listitem> + <listitem> + <simpara>get dbevent</simpara> + </listitem> + <listitem> + <simpara>prepare to commit</simpara> + </listitem> + <listitem> + <simpara> + rollback (see <function>ingres_rollback</function>) + </simpara> + </listitem> + <listitem><simpara>savepoint</simpara></listitem> + <listitem> + <simpara> + set autocommit (see <function>ingres_autocommit</function>) + </simpara> + </listitem> + <listitem> + <simpara>all cursor related queries are unsupported</simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + The connection link identifier. If not specified, the last opened link + is used. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>ingres_query</function> example</title> @@ -96,16 +128,22 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>ingres_fetch_array</function>, - <function>ingres_fetch_object</function>, - <function>ingres_fetch_row</function>, - <function>ingres_commit</function>, - <function>ingres_rollback</function>, and - <function>ingres_autocommit</function>. + <simplelist> + <member><function>ingres_fetch_array</function></member> + <member><function>ingres_fetch_object</function></member> + <member><function>ingres_fetch_row</function></member> + <member><function>ingres_commit</function></member> + <member><function>ingres_rollback</function></member> + <member><function>ingres_autocommit</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-rollback.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ingres-ii/functions/ingres-rollback.xml diff -u phpdoc/en/reference/ingres-ii/functions/ingres-rollback.xml:1.4 phpdoc/en/reference/ingres-ii/functions/ingres-rollback.xml:1.5 --- phpdoc/en/reference/ingres-ii/functions/ingres-rollback.xml:1.4 Sun Jun 10 19:06:37 2007 +++ phpdoc/en/reference/ingres-ii/functions/ingres-rollback.xml Sun Jun 10 19:07:03 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ingres-rollback"> <refnamediv> <refname>ingres_rollback</refname> <refpurpose>Roll back a transaction</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ingres_rollback</methodname> <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> @@ -21,13 +21,43 @@ This closes the transaction. A new one can be open by sending a query with <function>ingres_query</function>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link</parameter></term> + <listitem> + <para> + The connection link identifier. If not specified, the last opened link + is used. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also - <function>ingres_query</function>, - <function>ingres_commit</function>, and - <function>ingres_autocommit</function>. + &return.success; </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ingres_query</function></member> + <member><function>ingres_commit</function></member> + <member><function>ingres_autocommit</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file