File: gnupg-seterrormode.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (106 lines) | stat: -rw-r--r-- 2,786 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml: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>void</type><methodname>gnupg_seterrormode</methodname>
   <methodparam><type>resource</type><parameter>identifier</parameter></methodparam>
   <methodparam><type>int</type><parameter>errormode</parameter></methodparam>
  </methodsynopsis>
  <para>
   Sets the mode for <link linkend="ini.error-reporting">error_reporting</link>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>identifier</parameter></term>
     <listitem>
      &gnupg.identifier;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>errormode</parameter></term>
     <listitem>
      <para>
       The error mode.
      </para>
      <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>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </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:"~/.phpdoc/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
-->