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

From:	Mehdi Achour	Date:	Sun, 10 Jun 2007 19:06:37 +0000
Subject:	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
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969376622@lists.php.net to get a copy of this message

didou Sun Jun 10 19:06:37 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: WS, prepare for new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ingres-ii/functions/ingres-autocommit.xml?r1=1.5&r2=1.6&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.5 phpdoc/en/reference/ingres-ii/functions/ingres-autocommit.xml:1.6 --- phpdoc/en/reference/ingres-ii/functions/ingres-autocommit.xml:1.5 Tue Jul 19 14:22:55 2005 +++ phpdoc/en/reference/ingres-ii/functions/ingres-autocommit.xml Sun Jun 10 19:06:37 2007 @@ -1,39 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> - +  - <refentry id="function.ingres-autocommit"> - <refnamediv> - <refname>ingres_autocommit</refname> - <refpurpose>Switch autocommit on or off</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ingres_autocommit</methodname> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - <function>ingres_autocommit</function> is called before opening a - transaction (before the first call to - <function>ingres_query</function> or just after a call to - <function>ingres_rollback</function> or - <function>ingres_commit</function>) to switch the - "autocommit" mode of the server on or off (when the script begins - the autocommit mode is off). - </para> - <para> - When the autocommit mode is on, every query is automatically - committed by the server, as if <function>ingres_commit</function> - was called after every call to <function>ingres_query</function>. - </para> - <para> - See also - <function>ingres_query</function>, - <function>ingres_rollback</function>, and - <function>ingres_commit</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.ingres-autocommit"> + <refnamediv> + <refname>ingres_autocommit</refname> + <refpurpose>Switch autocommit on or off</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ingres_autocommit</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + <function>ingres_autocommit</function> is called before opening a + transaction (before the first call to + <function>ingres_query</function> or just after a call to + <function>ingres_rollback</function> or + <function>ingres_commit</function>) to switch the + "autocommit" mode of the server on or off (when the script begins + the autocommit mode is off). + </para> + <para> + When the autocommit mode is on, every query is automatically + committed by the server, as if <function>ingres_commit</function> + was called after every call to <function>ingres_query</function>. + </para> + <para> + See also + <function>ingres_query</function>, + <function>ingres_rollback</function>, and + <function>ingres_commit</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ingres-close"> - <refnamediv> - <refname>ingres_close</refname> - <refpurpose>Close an Ingres II database connection</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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>. - </para> - </refsect1> - </refentry> +<refentry id="function.ingres-close"> + <refnamediv> + <refname>ingres_close</refname> + <refpurpose>Close an Ingres II database connection</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ingres-commit"> - <refnamediv> - <refname>ingres_commit</refname> - <refpurpose>Commit a transaction</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ingres_commit</methodname> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - <function>ingres_commit</function> commits the currently open - transaction, making all changes made to the database permanent. - </para> - <para> - This closes the transaction. A new one can be open by sending a - query with <function>ingres_query</function>. - </para> - <para> - You can also have the server commit automatically after every - query by calling <function>ingres_autocommit</function> before - opening the transaction. - </para> - <para> - See also - <function>ingres_query</function>, - <function>ingres_rollback</function>, and - <function>ingres_autocommit</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.ingres-commit"> + <refnamediv> + <refname>ingres_commit</refname> + <refpurpose>Commit a transaction</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ingres_commit</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + <function>ingres_commit</function> commits the currently open + transaction, making all changes made to the database permanent. + </para> + <para> + This closes the transaction. A new one can be open by sending a + query with <function>ingres_query</function>. + </para> + <para> + You can also have the server commit automatically after every + query by calling <function>ingres_autocommit</function> before + opening the transaction. + </para> + <para> + See also + <function>ingres_query</function>, + <function>ingres_rollback</function>, and + <function>ingres_autocommit</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ingres-connect"> - <refnamediv> - <refname>ingres_connect</refname> - <refpurpose> - Open a connection to an Ingres database - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>ingres_connect</methodname> - <methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - Returns a Ingres link resource on success, or &false; on - failure. - </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>. - </para> - <para> - If some parameters are missing, <function>ingres_connect</function> - uses the values in &php.ini; for - <parameter>ingres.default_database</parameter>, - <parameter>ingres.default_user</parameter> and - <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. - </para> - <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> - <para> - <example> - <title><function>ingres_connect</function> example</title> - <programlisting role="php"> +<refentry id="function.ingres-connect"> + <refnamediv> + <refname>ingres_connect</refname> + <refpurpose>Open a connection to an Ingres database</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>ingres_connect</methodname> + <methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + Returns a Ingres link resource on success, or &false; on + failure. + </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>. + </para> + <para> + If some parameters are missing, <function>ingres_connect</function> + uses the values in &php.ini; for + <parameter>ingres.default_database</parameter>, + <parameter>ingres.default_user</parameter> and + <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. + </para> + <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> + <para> + <example> + <title><function>ingres_connect</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $link = ingres_connect("mydb", "user", "pass") @@ -197,13 +195,13 @@ ingres_close($link); ?> ]]> - </programlisting> - </example> - <example> - <title> - <function>ingres_connect</function> example using default link - </title> - <programlisting role="php"> + </programlisting> + </example> + <example> + <title> + <function>ingres_connect</function> example using default link + </title> + <programlisting role="php"> <![CDATA[ <?php ingres_connect("mydb", "user", "pass") @@ -212,15 +210,16 @@ ingres_close(); ?> ]]> - </programlisting> - </example> - </para> - <para> See also - <function>ingres_pconnect</function> and - <function>ingres_close</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also + <function>ingres_pconnect</function> and + <function>ingres_close</function>. + </para> + </refsect1> +</refentry>  +  - <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> - <methodsynopsis> - <type>string</type><methodname>ingres_cursor</methodname> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - Returns an string containing the active cursor name. If no cursor is - active then NULL is returned. - </para> - <para> - If a <parameter>link</parameter> resource is passed to - <function>ingres_cursor</function> it returns the cursor name recorded - for the link. If no link is passed then - <function>ingres_cursor</function> returns the cursor name asssociated - with the default link. - </para> - <para> - <example> - <title><function>ingres_cursor</function> example</title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>string</type><methodname>ingres_cursor</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + Returns an string containing the active cursor name. If no cursor is + active then NULL is returned. + </para> + <para> + If a <parameter>link</parameter> resource is passed to + <function>ingres_cursor</function> it returns the cursor name recorded + for the link. If no link is passed then + <function>ingres_cursor</function> returns the cursor name asssociated + with the default link. + </para> + <para> + <example> + <title><function>ingres_cursor</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $link = ingres_connect($database, $user, $password); @@ -39,16 +39,16 @@ ?> ]]> - </programlisting> - </example> - </para> - <para> - See also - <function>ingres_prepare</function> and - <function>ingres_execute</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also + <function>ingres_prepare</function> and + <function>ingres_execute</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ingres-errno"> - <refnamediv> - <refname>ingres_errno</refname> - <refpurpose>Gets the last ingres error number generated</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>ingres_errno</methodname> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - Returns an integer containing the last error number. If no error was - reported 0 is returned. - </para> - <para> - If a <parameter>link</parameter> resource is passed to - <function>ingres_errno</function> it returns the last error recorded for - the link. If no link is passed then <function>ingres_errno</function> - returns the last error reported using the default link. - </para> - <para> - The function, <function>ingres_errno</function>, should always be called - after executing a database query. Calling another function before - <function>ingres_errno</function> is called, will reset or change any - error code from the last Ingres function call. - </para> - <para> - <example> - <title><function>ingres_errno</function> example</title> - <programlisting role="php"> +<refentry id="function.ingres-errno"> + <refnamediv> + <refname>ingres_errno</refname> + <refpurpose>Gets the last ingres error number generated</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>ingres_errno</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + Returns an integer containing the last error number. If no error was + reported 0 is returned. + </para> + <para> + If a <parameter>link</parameter> resource is passed to + <function>ingres_errno</function> it returns the last error recorded for + the link. If no link is passed then <function>ingres_errno</function> + returns the last error reported using the default link. + </para> + <para> + The function, <function>ingres_errno</function>, should always be called + after executing a database query. Calling another function before + <function>ingres_errno</function> is called, will reset or change any + error code from the last Ingres function call. + </para> + <para> + <example> + <title><function>ingres_errno</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $link = ingres_connect($database, $user, $password); @@ -45,16 +45,16 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - See also - <function>ingres_error</function> and - <function>ingres_errsqlstate</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also + <function>ingres_error</function> and + <function>ingres_errsqlstate</function>. + </para> + </refsect1> +</refentry>  +  - <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> - <methodsynopsis> - <type>string</type><methodname>ingres_error</methodname> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - Returns a string containing the last error, or NULL if no error has - occurred. - </para> - <para> - If a <parameter>link</parameter> resource is passed to - <function>ingres_error</function> it returns the last error recorded for - the link. If no link is passed then <function>ingres_error</function> - returns the last error reported using the default link. - </para> - <para> - The function, <function>ingres_error</function>, should always be called - after executing any database query. Calling another function before - <function>ingres_error</function> is called will reset or change any - error message from the last Ingres function call. - </para> - <para> - <example> - <title><function>ingres_error</function> example</title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>string</type><methodname>ingres_error</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + Returns a string containing the last error, or NULL if no error has + occurred. + </para> + <para> + If a <parameter>link</parameter> resource is passed to + <function>ingres_error</function> it returns the last error recorded for + the link. If no link is passed then <function>ingres_error</function> + returns the last error reported using the default link. + </para> + <para> + The function, <function>ingres_error</function>, should always be called + after executing any database query. Calling another function before + <function>ingres_error</function> is called will reset or change any + error message from the last Ingres function call. + </para> + <para> + <example> + <title><function>ingres_error</function> example</title> + <programlisting role="php"> <![CDATA[ <?php ingres_connect($database, $user, $password); @@ -45,16 +45,16 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - See also - <function>ingres_errno</function> and - <function>ingres_errsqlstate</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also + <function>ingres_errno</function> and + <function>ingres_errsqlstate</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ingres-errsqlstate"> - <refnamediv> - <refname>ingres_errsqlstate</refname> - <refpurpose>Gets the last SQLSTATE error code generated</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>ingres_errsqlstate</methodname> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - Returns a string containing the last SQLSTATE, or NULL if no error has - occurred. - </para> - <para> - If a <parameter>link</parameter> resource is passed to - <function>ingres_errsqlstate</function> it returns the last error - recorded for the link. If no link is passed then - <function>ingres_errsqlstate</function> returns the last error reported - using the default link. - </para> - <para> - The function, <function>ingres_errsqlstate</function>, should always be - called after executing any database query. Calling another function - before <function>ingres_errsqlstate</function> is called will reset or - change any error message from the last Ingres function call. - </para> - <para> - <example> - <title><function>ingres_errsqlstate</function> example</title> - <programlisting role="php"> +<refentry id="function.ingres-errsqlstate"> + <refnamediv> + <refname>ingres_errsqlstate</refname> + <refpurpose>Gets the last SQLSTATE error code generated</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>ingres_errsqlstate</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + Returns a string containing the last SQLSTATE, or NULL if no error has + occurred. + </para> + <para> + If a <parameter>link</parameter> resource is passed to + <function>ingres_errsqlstate</function> it returns the last error + recorded for the link. If no link is passed then + <function>ingres_errsqlstate</function> returns the last error reported + using the default link. + </para> + <para> + The function, <function>ingres_errsqlstate</function>, should always be + called after executing any database query. Calling another function + before <function>ingres_errsqlstate</function> is called will reset or + change any error message from the last Ingres function call. + </para> + <para> + <example> + <title><function>ingres_errsqlstate</function> example</title> + <programlisting role="php"> <![CDATA[ <?php ingres_connect($database, $user, $password); @@ -46,16 +46,16 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - See also - <function>ingres_errno</function> and - <function>ingres_errsqlstate</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also + <function>ingres_errno</function> and + <function>ingres_errsqlstate</function>. + </para> + </refsect1> +</refentry>  +  - <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> - <methodsynopsis> - <type>array</type><methodname>ingres_fetch_array</methodname> - <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - <function>ingres_fetch_array</function> Returns an array that - corresponds to the fetched row, or &false; if there are no more - rows. - </para> - <para> - This function is an extended version of - <function>ingres_fetch_row</function>. In addition to storing - the data in the numeric indices of the result array, it also - stores the data in associative indices, using the field names as - keys. - </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 must use the numeric index of the - column or make an alias for the column. - <informalexample> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>array</type><methodname>ingres_fetch_array</methodname> + <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + <function>ingres_fetch_array</function> Returns an array that + corresponds to the fetched row, or &false; if there are no more + rows. + </para> + <para> + This function is an extended version of + <function>ingres_fetch_row</function>. In addition to storing + the data in the numeric indices of the result array, it also + stores the data in associative indices, using the field names as + keys. + </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 must use the numeric index of the + column or make an alias for the column. + <informalexample> + <programlisting role="php"> <![CDATA[ <?php @@ -42,24 +42,24 @@ ?> ]]> - </programlisting> - </informalexample> - </para> - <para> - <parameter>result_type</parameter> can be INGRES_NUM for - enumerated array, INGRES_ASSOC for associative array, or - INGRES_BOTH (default). - </para> - <para> - Speed-wise, the function is identical to - <function>ingres_fetch_object</function>, and almost as quick as - <function>ingres_fetch_row</function> (the difference is - insignificant). - </para> - <para> - <example> - <title><function>ingres_fetch_array</function> example</title> - <programlisting role="php"> + </programlisting> + </informalexample> + </para> + <para> + <parameter>result_type</parameter> can be INGRES_NUM for + enumerated array, INGRES_ASSOC for associative array, or + INGRES_BOTH (default). + </para> + <para> + Speed-wise, the function is identical to + <function>ingres_fetch_object</function>, and almost as quick as + <function>ingres_fetch_row</function> (the difference is + insignificant). + </para> + <para> + <example> + <title><function>ingres_fetch_array</function> example</title> + <programlisting role="php"> <![CDATA[ <?php ingres_connect($database, $user, $password); @@ -73,19 +73,19 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - See also - <function>ingres_query</function>, - <function>ingres_num_fields</function>, - <function>ingres_field_name</function>, - <function>ingres_fetch_object</function>, and - <function>ingres_fetch_row</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also + <function>ingres_query</function>, + <function>ingres_num_fields</function>, + <function>ingres_field_name</function>, + <function>ingres_fetch_object</function>, and + <function>ingres_fetch_row</function>. + </para> + </refsect1> +</refentry>  +  - <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> - <methodsynopsis> - <type>object</type><methodname>ingres_fetch_object</methodname> - <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - <function>ingres_fetch_object</function> Returns an object that - corresponds to the fetched row, or &false; if there are no more - rows. - </para> - <para> - This function is similar to - <function>ingres_fetch_array</function>, with one difference - an - object is returned, instead of an array. Indirectly, that means - that you can only access the data by the field names, and not by - their offsets (numbers are illegal property names). - </para> - <para> - The optional argument <parameter>result_type</parameter> is a - constant and can take the following values: INGRES_ASSOC, - INGRES_NUM, and INGRES_BOTH. - </para> - <para> - Speed-wise, the function is identical to - <function>ingres_fetch_array</function>, and almost as quick as - <function>ingres_fetch_row</function> (the difference is - insignificant). - </para> - <para> - <example> - <title><function>ingres_fetch_object</function> example</title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>object</type><methodname>ingres_fetch_object</methodname> + <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + <function>ingres_fetch_object</function> Returns an object that + corresponds to the fetched row, or &false; if there are no more + rows. + </para> + <para> + This function is similar to + <function>ingres_fetch_array</function>, with one difference - an + object is returned, instead of an array. Indirectly, that means + that you can only access the data by the field names, and not by + their offsets (numbers are illegal property names). + </para> + <para> + The optional argument <parameter>result_type</parameter> is a + constant and can take the following values: INGRES_ASSOC, + INGRES_NUM, and INGRES_BOTH. + </para> + <para> + Speed-wise, the function is identical to + <function>ingres_fetch_array</function>, and almost as quick as + <function>ingres_fetch_row</function> (the difference is + insignificant). + </para> + <para> + <example> + <title><function>ingres_fetch_object</function> example</title> + <programlisting role="php"> <![CDATA[ <?php ingres_connect($database, $user, $password); @@ -50,19 +50,19 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - See also - <function>ingres_query</function>, - <function>ingres_num_fields</function>, - <function>ingres_field_name</function>, - <function>ingres_fetch_array</function>, and - <function>ingres_fetch_row</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also + <function>ingres_query</function>, + <function>ingres_num_fields</function>, + <function>ingres_field_name</function>, + <function>ingres_fetch_array</function>, and + <function>ingres_fetch_row</function>. + </para> + </refsect1> +</refentry>  +  - <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> - <methodsynopsis> - <type>array</type><methodname>ingres_fetch_row</methodname> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - <function>ingres_fetch_row</function> returns an array that - corresponds to the fetched row, or &false; if there are no more - rows. Each result column is stored in an array offset, starting - at offset 1. - </para> - <para> - Subsequent call to <function>ingres_fetch_row</function> would - return the next row in the result set, or &false; if there are no - more rows. - </para> - <para> - <example> - <title><function>ingres_fetch_row</function> example</title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>array</type><methodname>ingres_fetch_row</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + <function>ingres_fetch_row</function> returns an array that + corresponds to the fetched row, or &false; if there are no more + rows. Each result column is stored in an array offset, starting + at offset 1. + </para> + <para> + Subsequent call to <function>ingres_fetch_row</function> would + return the next row in the result set, or &false; if there are no + more rows. + </para> + <para> + <example> + <title><function>ingres_fetch_row</function> example</title> + <programlisting role="php"> <![CDATA[ <?php ingres_connect($database, $user, $password); @@ -40,18 +38,18 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - See also - <function>ingres_num_fields</function>, - <function>ingres_query</function>, - <function>ingres_fetch_array</function>, and - <function>ingres_fetch_object</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also + <function>ingres_num_fields</function>, + <function>ingres_query</function>, + <function>ingres_fetch_array</function>, and + <function>ingres_fetch_object</function>. + </para> + </refsect1> +</refentry>  +  - <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> - <methodsynopsis> - <type>int</type><methodname>ingres_field_length</methodname> - <methodparam><type>int</type><parameter>index</parameter></methodparam> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - <function>ingres_field_length</function> returns the length of a - field. This is the number of bytes used by the server to store - the field. For detailed information, see the Ingres/OpenAPI User - Guide - Appendix C. - </para> - <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>. - </para> - </refsect1> - </refentry> +<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> + <methodsynopsis> + <type>int</type><methodname>ingres_field_length</methodname> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + <function>ingres_field_length</function> returns the length of a + field. This is the number of bytes used by the server to store + the field. For detailed information, see the Ingres/OpenAPI User + Guide - Appendix C. + </para> + <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>. + </para> + </refsect1> +</refentry>  +  - <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> - <methodsynopsis> - <type>string</type><methodname>ingres_field_name</methodname> - <methodparam><type>int</type><parameter>index</parameter></methodparam> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - <function>ingres_field_name</function> returns the name of a field - in a query result, or &false; on failure. - </para> - <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>. - </para> - </refsect1> - </refentry> +<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> + <methodsynopsis> + <type>string</type><methodname>ingres_field_name</methodname> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + <function>ingres_field_name</function> returns the name of a field + in a query result, or &false; on failure. + </para> + <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>. + </para> + </refsect1> +</refentry>  +  - <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> - <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. - </para> - <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>. - </para> - </refsect1> - </refentry> +<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> + <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. + </para> + <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>. + </para> + </refsect1> +</refentry>  +  - <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> - <methodsynopsis> - <type>int</type><methodname>ingres_field_precision</methodname> - <methodparam><type>int</type><parameter>index</parameter></methodparam> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - <function>ingres_field_precision</function> returns the precision - of a field. This value is used only for decimal, float and money - SQL data types. For detailed information, see the Ingres/OpenAPI - User Guide - Appendix C. - </para> - <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>. - </para> - </refsect1> - </refentry> +<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> + <methodsynopsis> + <type>int</type><methodname>ingres_field_precision</methodname> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + <function>ingres_field_precision</function> returns the precision + of a field. This value is used only for decimal, float and money + SQL data types. For detailed information, see the Ingres/OpenAPI + User Guide - Appendix C. + </para> + <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>. + </para> + </refsect1> +</refentry>  +  - <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> - <methodsynopsis> - <type>int</type><methodname>ingres_field_scale</methodname> - <methodparam><type>int</type><parameter>index</parameter></methodparam> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - <function>ingres_field_scale</function> returns the scale of a - field. This value is used only for the decimal SQL data - type. For detailed information, see the Ingres/OpenAPI User Guide - - Appendix C. - </para> - <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>. - </para> - </refsect1> - </refentry> +<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> + <methodsynopsis> + <type>int</type><methodname>ingres_field_scale</methodname> + <methodparam><type>int</type><parameter>index</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + <function>ingres_field_scale</function> returns the scale of a + field. This value is used only for the decimal SQL data + type. For detailed information, see the Ingres/OpenAPI User Guide + - Appendix C. + </para> + <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>. + </para> + </refsect1> +</refentry>  +  - <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> - <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> - <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", - "IIAPI_DTE_TYPE", "IIAPI_FLT_TYPE", "IIAPI_INT_TYPE", - "IIAPI_VCH_TYPE". Some of these types can map to more than one - SQL type depending on the length of the field (see - <function>ingres_field_length</function>). For example - "IIAPI_FLT_TYPE" can be a float4 or a float8. For detailed - information, see the Ingres/OpenAPI User Guide - Appendix C. - </para> - <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>. - </para> - </refsect1> - </refentry> +<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> + <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> + <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", + "IIAPI_DTE_TYPE", "IIAPI_FLT_TYPE", "IIAPI_INT_TYPE", + "IIAPI_VCH_TYPE". Some of these types can map to more than one + SQL type depending on the length of the field (see + <function>ingres_field_length</function>). For example + "IIAPI_FLT_TYPE" can be a float4 or a float8. For detailed + information, see the Ingres/OpenAPI User Guide - Appendix C. + </para> + <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>. + </para> + </refsect1> +</refentry>  +  - <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> - <methodsynopsis> - <type>int</type><methodname>ingres_num_fields</methodname> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - <function>ingres_num_fields</function> returns the number of - fields in the results returned by the Ingres server after a call - to <function>ingres_query</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>. - </para> - </refsect1> - </refentry> +<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> + <methodsynopsis> + <type>int</type><methodname>ingres_num_fields</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + <function>ingres_num_fields</function> returns the number of + fields in the results returned by the Ingres server after a call + to <function>ingres_query</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>. + </para> + </refsect1> +</refentry>  +  - <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> - <methodsynopsis> - <type>int</type><methodname>ingres_num_rows</methodname> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <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> - <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>. - </para> - </refsect1> - </refentry> +<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> + <methodsynopsis> + <type>int</type><methodname>ingres_num_rows</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <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> + <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>. + </para> + </refsect1> +</refentry>  +  - <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> - <methodsynopsis> - <type>resource</type><methodname>ingres_pconnect</methodname> - <methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> - </methodsynopsis> - <para> - Returns a Ingres II link resource on success, or &false; on - failure. - </para> - <para> - See <function>ingres_connect</function> for parameters details - and examples. There are only 2 differences between - <function>ingres_pconnect</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 - identifier for it will be returned instead of opening a new - connection. Second, the connection to the Ingres server will not - be closed when the execution of the script ends. Instead, the - link will remain open for future use - (<function>ingres_close</function> will not close links - 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>. - </para> - </refsect1> - </refentry> +<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> + <methodsynopsis> + <type>resource</type><methodname>ingres_pconnect</methodname> + <methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> + <para> + Returns a Ingres II link resource on success, or &false; on + failure. + </para> + <para> + See <function>ingres_connect</function> for parameters details + and examples. There are only 2 differences between + <function>ingres_pconnect</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 + identifier for it will be returned instead of opening a new + connection. Second, the connection to the Ingres server will not + be closed when the execution of the script ends. Instead, the + link will remain open for future use + (<function>ingres_close</function> will not close links + 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>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ingres-query"> - <refnamediv> - <refname>ingres_query</refname> - <refpurpose>Send a SQL query to Ingres II</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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) - </para> - <para> - The query becomes part of the currently open transaction. If - there is no open transaction, <function>ingres_query</function> - opens a new transaction. To close the transaction, you can either - call <function>ingres_commit</function> to commit the changes - made to the database or <function>ingres_rollback</function> to - cancel these changes. When the script ends, any open transaction - is rolled back (by calling - <function>ingres_rollback</function>). You can also use - <function>ingres_autocommit</function> before opening a new - transaction to have every SQL query immediately committed. - </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> - <para> - <example> - <title><function>ingres_query</function> example</title> - <programlisting role="php"> +<refentry id="function.ingres-query"> + <refnamediv> + <refname>ingres_query</refname> + <refpurpose>Send a SQL query to Ingres II</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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) + </para> + <para> + The query becomes part of the currently open transaction. If + there is no open transaction, <function>ingres_query</function> + opens a new transaction. To close the transaction, you can either + call <function>ingres_commit</function> to commit the changes + made to the database or <function>ingres_rollback</function> to + cancel these changes. When the script ends, any open transaction + is rolled back (by calling + <function>ingres_rollback</function>). You can also use + <function>ingres_autocommit</function> before opening a new + transaction to have every SQL query immediately committed. + </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> + <para> + <example> + <title><function>ingres_query</function> example</title> + <programlisting role="php"> <![CDATA[ <?php ingres_connect($database, $user, $password); @@ -93,20 +93,20 @@ } ?> ]]> - </programlisting> - </example> - </para> - <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>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <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>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ingres-rollback"> - <refnamediv> - <refname>ingres_rollback</refname> - <refpurpose>Roll back a transaction</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ingres_rollback</methodname> - <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> - </methodsynopsis> - <para> - <function>ingres_rollback</function> rolls back the currently - open transaction, actually canceling all changes made to the - database during the transaction. - </para> - <para> - This closes the transaction. A new one can be open by sending a - query with <function>ingres_query</function>. - </para> - <para> - See also - <function>ingres_query</function>, - <function>ingres_commit</function>, and - <function>ingres_autocommit</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.ingres-rollback"> + <refnamediv> + <refname>ingres_rollback</refname> + <refpurpose>Roll back a transaction</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ingres_rollback</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link</parameter></methodparam> + </methodsynopsis> + <para> + <function>ingres_rollback</function> rolls back the currently + open transaction, actually canceling all changes made to the + database during the transaction. + </para> + <para> + This closes the transaction. A new one can be open by sending a + query with <function>ingres_query</function>. + </para> + <para> + See also + <function>ingres_query</function>, + <function>ingres_commit</function>, and + <function>ingres_autocommit</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: