<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.rnp.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.rnp-key-revoke.php',
    1 => 'rnp_key_revoke',
    2 => 'Revoke a key or subkey by generating and adding revocation signature',
  ),
  'up' => 
  array (
    0 => 'ref.rnp.php',
    1 => 'Rnp 関数',
  ),
  'prev' => 
  array (
    0 => 'function.rnp-key-remove.php',
    1 => 'rnp_key_remove',
  ),
  'next' => 
  array (
    0 => 'function.rnp-list-keys.php',
    1 => 'rnp_list_keys',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/rnp/functions/rnp-key-revoke.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.rnp-key-revoke" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">rnp_key_revoke</h1>
  <p class="verinfo">(PECL rnp &gt;= 0.1.1)</p><p class="refpurpose"><span class="refname">rnp_key_revoke</span> &mdash; <span class="dc-title">Revoke a key or subkey by generating and adding revocation signature</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.rnp-key-revoke-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>rnp_key_revoke</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="class.rnpffi.php" class="type RnpFFI">RnpFFI</a></span> <code class="parameter">$ffi</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$key_fp</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$options</code><span class="initializer"> = ?</span></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   Note: you need to call <span class="function"><a href="function.rnp-save-keys.php" class="function">rnp_save_keys()</a></span> to write updated keyring(s) out.
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.rnp-key-revoke-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">ffi</code></dt>
    <dd>
     <span class="simpara">
      The FFI object returned by <span class="function"><a href="function.rnp-ffi-create.php" class="function">rnp_ffi_create()</a></span>.
     </span>
    </dd>
   
   
    <dt><code class="parameter">key_fp</code></dt>
    <dd>
     <span class="simpara">
      Key fingerprint.
     </span>
    </dd>
   
   
    <dt><code class="parameter">flags</code></dt>
    <dd>
     <span class="simpara">
      Currently must be 0.
     </span>
    </dd>
   
   
    <dt><code class="parameter">options</code></dt>
    <dd>
     <span class="simpara">
      An associative array with options.
     </span>
     <table class="doctable informaltable">
      
       <thead>
        <tr>
         <th>Key</th>
         <th>Data type</th>
         <th>説明</th>
        </tr>

       </thead>

       <tbody class="tbody">
        <tr>
         <td><code class="literal">&quot;hash&quot;</code></td>
         <td>string</td>
         <td>Set hash algorithm used during signature calculation.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;code&quot;</code></td>
         <td>string</td>
         <td>Code reason for revocation code. Possible values: &#039;no&#039;, &#039;superseded&#039;, &#039;compromised&#039;,
          &#039;retired&#039;. If not defined, then value &#039;no&#039; will be used by default.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;reason&quot;</code></td>
         <td>string</td>
         <td>Textual representation of the reason for revocation.</td>
        </tr>

       </tbody>
      
     </table>

    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.rnp-key-revoke-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="simpara">
   Returns <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> on success失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します.
  </p>
 </div>



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