added documentation for the new seterrormode-function

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@200399 c90b9560-bf6c-de11-be94-00142212c4b1

reference/gnupg/constants.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <section id='gnupg.constants'>
  &reftitle.constants;
  <variablelist>
@@ -242,6 +242,39 @@
    <listitem>
     <simpara>
 
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>GNUPG_ERROR_WARNING</constant>
+    (<type>integer</type>)
+   </term>
+   <listitem>
+    <simpara>
+
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>GNUPG_ERROR_EXCEPTION</constant>
+    (<type>integer</type>)
+   </term>
+   <listitem>
+    <simpara>
+
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>GNUPG_ERROR_SILENT</constant>
+    (<type>integer</type>)
+   </term>
+   <listitem>
+    <simpara>
+
     </simpara>
    </listitem>
   </varlistentry>

reference/gnupg/functions.xml

@@ -14,6 +14,7 @@
 &reference.gnupg.functions.gnupg-import;
 &reference.gnupg.functions.gnupg-keyinfo;
 &reference.gnupg.functions.gnupg-setarmor;
+&reference.gnupg.functions.gnupg-seterrormode;
 &reference.gnupg.functions.gnupg-setsignmode;
 &reference.gnupg.functions.gnupg-sign;
 &reference.gnupg.functions.gnupg-verify;

reference/gnupg/functions/gnupg-seterrormode.xml

@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<refentry id="function.gnupg-seterrormode">
+ <refnamediv>
+  <refname>gnupg_seterrormode</refname>
+  <refpurpose>Sets the mode for error_reporting</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>gnupg_errormode</methodname>
+   <methodparam><type>resource</type><parameter>identifier</parameter></methodparam>
+   <methodparam><type>int</type><parameter>errormode</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   <parameter>errormode</parameter> takes a constant indicating what type of
+   error_reporting should be used. The possible values are
+   <constant>GNUPG_ERROR_WARNING</constant>,
+   <constant>GNUPG_ERROR_EXCEPTION</constant> and
+   <constant>GNUPG_ERROR_SILENT</constant>.
+   By default <constant>GNUPG_ERROR_SILENT</constant> is used.
+  </para>
+ </refsect1>
+ 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>Procedural <function>gnupg_seterrormode</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$res = gnupg_init();
+gnupg_seterrormode($res,GNUPG_ERROR_WARNING); // raise a PHP-Warning in case
+of an error
+?>
+]]>
+    </programlisting>
+   </example>
+   <example>
+    <title>OO <function>gnupg_seterrormode</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$gpg = new gnupg();
+$gpg -> seterrormode(gnupg::ERROR_EXCEPTION); // throw an exception in case of
+an error
+?>
+]]>
+    </programlisting>
+   </example>
+  </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
+-->