php-doc-en/reference/gnupg/functions/gnupg-decryptverify.xml
Jakub Vrana 2af8b17040 Fix parameters
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@201928 c90b9560-bf6c-de11-be94-00142212c4b1
2005-12-02 21:41:41 +00:00

88 lines
2.4 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.gnupg-decryptverify">
<refnamediv>
<refname>gnupg_decryptverify</refname>
<refpurpose>Decrypts and verifies a given text</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>gnupg_decryptverify</methodname>
<methodparam><type>resource</type><parameter>identifier</parameter></methodparam>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
<methodparam role="reference"><type>string</type><parameter>plaintext</parameter></methodparam>
</methodsynopsis>
<para>
Decrypts and verifies a given text and returns information about the
signature.
The parameter <parameter>plaintext</parameter> gets filled with the decrypted
text.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
On success, this function returns information about the signature and
fills the <parameter>plaintext</parameter> parameter with the decrypted text.
On failure, this function returns &false;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Procedural <function>gnupg_decryptverify</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$plaintext = "";
$res = gnupg_init();
gnupg_adddecryptkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test");
$info = gnupg_decryptverify($res,$text,$plaintext);
print_r($info);
?>
]]>
</programlisting>
</example>
<example>
<title>OO <function>gnupg_decryptverify</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$plaintext = "";
$gpg = new gnupg();
$gpg -> adddecryptkey("8660281B6051D071D94B5B230549F9DC851566DC","test");
$info = $gpg -> decryptverify($text,$plaintext);
print_r($info);
?>
]]>
</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
-->