[PHP-DOC] cvs: phpdoc /en/reference/gnupg constants.xml functions.xml /en/reference/gnupg/functions gnupg-seterrormode.xml

[Thilo Raufeisen]

traufeisen              Sat Nov 12 09:39:43 2005 EDT

  Added files:                 
    /phpdoc/en/reference/gnupg/functions        gnupg-seterrormode.xml 

  Modified files:              
    /phpdoc/en/reference/gnupg  constants.xml functions.xml 
  Log:
  added documentation for the new seterrormode-function
  
  
http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/constants.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/gnupg/constants.xml
diff -u phpdoc/en/reference/gnupg/constants.xml:1.2 
phpdoc/en/reference/gnupg/constants.xml:1.3
--- phpdoc/en/reference/gnupg/constants.xml:1.2 Sun Oct 30 01:34:36 2005
+++ phpdoc/en/reference/gnupg/constants.xml     Sat Nov 12 09:39:43 2005
@@ -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>
@@ -245,6 +245,39 @@
     </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>
  </variablelist>
 </section>
 <!-- Keep this comment at the end of the file
http://cvs.php.net/diff.php/phpdoc/en/reference/gnupg/functions.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/gnupg/functions.xml
diff -u phpdoc/en/reference/gnupg/functions.xml:1.1 
phpdoc/en/reference/gnupg/functions.xml:1.2
--- phpdoc/en/reference/gnupg/functions.xml:1.1 Sat Oct 29 12:08:06 2005
+++ phpdoc/en/reference/gnupg/functions.xml     Sat Nov 12 09:39:43 2005
@@ -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;

http://cvs.php.net/co.php/phpdoc/en/reference/gnupg/functions/gnupg-seterrormode.xml?r=1.1&p=1
Index: phpdoc/en/reference/gnupg/functions/gnupg-seterrormode.xml
+++ phpdoc/en/reference/gnupg/functions/gnupg-seterrormode.xml
<?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
-->