php-doc-en/reference/gnupg/functions/gnupg-getprotocol.xml
Philip Olson 7ff2ef1670 Added refsect1 role="parameters"
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@260114 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-21 21:06:43 +00:00

88 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gnupg-getprotocol">
<refnamediv>
<refname>gnupg_getprotocol</refname>
<refpurpose>Returns the currently active protocol for all operations</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>gnupg_getprotocol</methodname>
<methodparam><type>resource</type><parameter>identifier</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>identifier</parameter></term>
<listitem>
&gnupg.identifier;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the currently active protocol, which can be one of
<constant>GNUPG_PROTOCOL_OpenPGP</constant> or
<constant>GNUPG_PROTOCOL_CMS</constant>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Procedural <function>gnupg_getprotocol</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$res = gnupg_init();
echo gnupg_getprotocol($res);
?>
]]>
</programlisting>
</example>
<example>
<title>OO <function>gnupg_getprotocol</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$gpg = new gnupg();
echo $gpg -> getprotocol();
?>
]]>
</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
-->