php-doc-en/reference/gnupg/functions/gnupg-setarmor.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.gnupg-setarmor">
 <refnamediv>
  <refname>gnupg_setarmor</refname>
  <refpurpose>Toggle armored output</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>gnupg_setarmor</methodname>
   <methodparam><type>resource</type><parameter>identifier</parameter></methodparam>
   <methodparam><type>int</type><parameter>armor</parameter></methodparam>
  </methodsynopsis>
  <para>
    Pass a non-zero interger-value to this function to enable armored-output
    (default).
    Pass 0 to disable armored output.
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
    On success, this function returns &true;.
    On failure, this function returns &false;.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>procedural <function>gnupg_setarmor</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$res = gnupg_init();
gnupg_setarmor($res,1); // enable armored output;
gnupg_setarmor($res,0); // disable armored output;
?>
]]>
    </programlisting>
   </example>
   <example>
     <title>OO <function>gnupg_setarmor</function> example</title>
     <programlisting role="php">
<![CDATA[
<?php
$gpg = new gnupg();
$gpg -> setarmor(1); // enable armored output;
$gpg -> setarmor(0); // disable armored output;
?>
]]>
     </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
-->