<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = 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-getengineinfo.php',
    1 => 'gnupg_getengineinfo',
    2 => 'Returns the engine info',
  ),
  'up' => 
  array (
    0 => 'ref.gnupg.php',
    1 => 'GnuPG Functions',
  ),
  'prev' => 
  array (
    0 => 'function.gnupg-export.php',
    1 => 'gnupg_export',
  ),
  'next' => 
  array (
    0 => 'function.gnupg-geterror.php',
    1 => 'gnupg_geterror',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/gnupg/functions/gnupg-getengineinfo.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.gnupg-getengineinfo" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">gnupg_getengineinfo</h1>
  <p class="verinfo">(PECL gnupg &gt;= 1.5)</p><p class="refpurpose"><span class="refname">gnupg_getengineinfo</span> &mdash; <span class="dc-title">Returns the engine info</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.gnupg-getengineinfo-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>gnupg_getengineinfo</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$identifier</code></span>): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.gnupg-getengineinfo-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">identifier</code></dt>
    <dd>
     <p class="para">The gnupg identifier, from a call to
<span class="function"><a href="function.gnupg-init.php" class="function">gnupg_init()</a></span> or <span class="classname"><strong class="classname">gnupg</strong></span>.</p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.gnupg-getengineinfo-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   Returns an array with engine info consting of <code class="literal">protocol</code>,
   <code class="literal">file_name</code> and <code class="literal">home_dir</code>.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.gnupg-getengineinfo-examples">
  <h3 class="title">Examples</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Example #1 Procedural <span class="function"><strong>gnupg_getengineinfo()</strong></span> example</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$res </span><span style="color: #007700">= </span><span style="color: #0000BB">gnupg_init</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">gnupg_getengineinfo</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>The above example will output:</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">array(3) {
  [&quot;protocol&quot;]=&gt;
  int(0)
  [&quot;file_name&quot;]=&gt;
  string(12) &quot;/usr/bin/gpg&quot;
  [&quot;home_dir&quot;]=&gt;
  string(0) &quot;&quot;
}</pre>
</div>
    </div>
   </div>
   <div class="example" id="example-2">
    <p><strong>Example #2 OO <span class="function"><strong>gnupg_getengineinfo()</strong></span> example</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$gpg </span><span style="color: #007700">= new </span><span style="color: #0000BB">gnupg</span><span style="color: #007700">([</span><span style="color: #DD0000">"file_name" </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">"/usr/bin/gpg2"</span><span style="color: #007700">, </span><span style="color: #DD0000">"home_dir" </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">"/var/www/.gnupg"</span><span style="color: #007700">]);<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$gpg</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getengineinfo</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>The above example will output:</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">array(3) {
  [&quot;protocol&quot;]=&gt;
  int(0)
  [&quot;file_name&quot;]=&gt;
  string(13) &quot;/usr/bin/gpg2&quot;
  [&quot;home_dir&quot;]=&gt;
  string(15) &quot;/var/www/.gnupg&quot;
}</pre>
</div>
    </div>
   </div>
  </p>
 </div>

</div><?php manual_footer($setup); ?>