From c97dd01b044c7637f063f5b8ce83f1b7f31452d3 Mon Sep 17 00:00:00 2001
From: Grant Croker <grantc@php.net>
Date: Fri, 7 Oct 2005 16:32:06 +0000
Subject: [PATCH] New functions + ini entries

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@197883 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../ingres-ii/functions/ingres-cursor.xml     | 72 +++++++++++++++++
 .../ingres-ii/functions/ingres-errno.xml      | 78 ++++++++++++++++++
 .../ingres-ii/functions/ingres-error.xml      | 78 ++++++++++++++++++
 .../functions/ingres-errsqlstate.xml          | 79 +++++++++++++++++++
 reference/ingres-ii/ini.xml                   | 22 +++++-
 5 files changed, 327 insertions(+), 2 deletions(-)
 create mode 100644 reference/ingres-ii/functions/ingres-cursor.xml
 create mode 100644 reference/ingres-ii/functions/ingres-errno.xml
 create mode 100644 reference/ingres-ii/functions/ingres-error.xml
 create mode 100644 reference/ingres-ii/functions/ingres-errsqlstate.xml

diff --git a/reference/ingres-ii/functions/ingres-cursor.xml b/reference/ingres-ii/functions/ingres-cursor.xml
new file mode 100644
index 0000000000..0b33ad96aa
--- /dev/null
+++ b/reference/ingres-ii/functions/ingres-cursor.xml
@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 -->
+  <refentry id="function.ingres-error">
+   <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);
+
+ingres_prepare("select * from table", $link);
+
+$cursor_name = ingres_cursor($link);
+
+echo $cursor_name;
+
+?>
+]]>
+      </programlisting>
+     </example>
+    </para>
+    <para>
+     See also
+     <function>ingres_prepare</function> and
+     <function>ingres_execute</function>.
+    </para>
+   </refsect1>
+  </refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/ingres-ii/functions/ingres-errno.xml b/reference/ingres-ii/functions/ingres-errno.xml
new file mode 100644
index 0000000000..967913a28d
--- /dev/null
+++ b/reference/ingres-ii/functions/ingres-errno.xml
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 -->
+  <refentry id="function.ingres-error">
+   <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_error</function> example</title>
+      <programlisting role="php">
+<![CDATA[
+<?php
+$link = ingres_connect($database, $user, $password);
+
+ingres_query("select * from table", $link);
+
+$error_code = ingres_errno($link);
+
+if ( $error_code != 0 ) {
+   echo "An error occured - " . $error_code;
+}
+?>
+]]>
+      </programlisting>
+     </example>
+    </para>
+    <para>
+     See also
+     <function>ingres_error</function> and
+     <function>ingres_errsqlstate</function>.
+    </para>
+   </refsect1>
+  </refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/ingres-ii/functions/ingres-error.xml b/reference/ingres-ii/functions/ingres-error.xml
new file mode 100644
index 0000000000..3f6a09b660
--- /dev/null
+++ b/reference/ingres-ii/functions/ingres-error.xml
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 -->
+  <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);
+
+ingres_query("select * from table");
+
+$error_text = ingres_error();
+
+if ( is_null($error_text) ) {
+   echo "An error occured - " . $error_text;
+}
+?>
+]]>
+      </programlisting>
+     </example>
+    </para>
+    <para>
+     See also
+     <function>ingres_errno</function> and
+     <function>ingres_errsqlstate</function>.
+    </para>
+   </refsect1>
+  </refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/ingres-ii/functions/ingres-errsqlstate.xml b/reference/ingres-ii/functions/ingres-errsqlstate.xml
new file mode 100644
index 0000000000..32a9ace0a2
--- /dev/null
+++ b/reference/ingres-ii/functions/ingres-errsqlstate.xml
@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 -->
+  <refentry id="function.ingres-error">
+   <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);
+
+ingres_query("select * from table");
+
+$error_sqlstate = ingres_errsqlstate();
+
+if ( is_null($error_sqlstate) ) {
+   echo "An error occured - " . $error_sqlstate;
+}
+?>
+]]>
+      </programlisting>
+     </example>
+    </para>
+    <para>
+     See also
+     <function>ingres_errno</function> and
+     <function>ingres_errsqlstate</function>.
+    </para>
+   </refsect1>
+  </refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/ingres-ii/ini.xml b/reference/ingres-ii/ini.xml
index ddf7fe353f..747071b78e 100644
--- a/reference/ingres-ii/ini.xml
+++ b/reference/ingres-ii/ini.xml
@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <section id="ingres.configuration">
  &reftitle.runtime;
  &extension.runtime;
  <para>
  <table>
-  <title>Ingres II configuration options</title>
+  <title>Ingres configuration options</title>
   <tgroup cols="4">
    <thead>
     <row>
@@ -52,6 +52,24 @@
      <entry>PHP_INI_ALL</entry>
      <entry>Available since PHP 4.0.2.</entry>
     </row>
+    <row>
+     <entry>ingres.report_db_warnings</entry>
+     <entry>"1"</entry>
+     <entry>PHP_INI_ALL</entry>
+     <entry>Available since version 1.1.0 of the PECL extension.</entry>
+    </row>
+    <row>
+     <entry>ingres.cursor_mode</entry>
+     <entry>"0"</entry>
+     <entry>PHP_INI_ALL</entry>
+     <entry>Available since version 1.1.0 of the PECL extension.</entry>
+    </row>
+    <row>
+     <entry>ingres.blob_segment_length</entry>
+     <entry>"4096"</entry>
+     <entry>PHP_INI_ALL</entry>
+     <entry>Available since version 1.2.0 of the PECL extension.</entry>
+    </row>
    </tbody>
   </tgroup>
  </table>