Source of: /manual/en/function.gnupg-getprotocol.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.gnupg.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.gnupg-getprotocol.php',
1 => 'gnupg_getprotocol',
),
'up' =>
array (
0 => 'ref.gnupg.php',
1 => 'GnuPG Functions',
),
'prev' =>
array (
0 => 'function.gnupg-geterror.php',
1 => 'gnupg_geterror',
),
'next' =>
array (
0 => 'function.gnupg-import.php',
1 => 'gnupg_import',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.gnupg-getprotocol" class="refentry">
<div class="refnamediv">
<h1 class="refname">gnupg_getprotocol</h1>
<p class="verinfo">(PECL gnupg >= 0.1)</p><p class="refpurpose"><span class="refname">gnupg_getprotocol</span> — <span class="dc-title">Returns the currently active protocol for all operations</span></p>
</div>
<a name="function.gnupg-getprotocol.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><b>gnupg_getprotocol</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$identifier</tt></span>
)</div>
</div>
<a name="function.gnupg-getprotocol.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">identifier</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">The gnupg identifier, from a call to
<a href="function.gnupg-init.php" class="function">gnupg_init()</a> or <b class="classname">gnupg</b>.</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.gnupg-getprotocol.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the currently active protocol, which can be one of
<b><tt class="constant">GNUPG_PROTOCOL_OpenPGP</tt></b> or
<b><tt class="constant">GNUPG_PROTOCOL_CMS</tt></b>.
</p>
</div>
<a name="function.gnupg-getprotocol.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 Procedural <b>gnupg_getprotocol()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$res </span><span style="color: #007700">= </span><span style="color: #0000BB">gnupg_init</span><span style="color: #007700">();<br />echo </span><span style="color: #0000BB">gnupg_getprotocol</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p><div class="example">
<p><b>Example #2 OO <b>gnupg_getprotocol()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$gpg </span><span style="color: #007700">= new </span><span style="color: #0000BB">gnupg</span><span style="color: #007700">();<br />echo </span><span style="color: #0000BB">$gpg </span><span style="color: #007700">-> </span><span style="color: #0000BB">getprotocol</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
</div><?php manual_footer(); ?>
