rnp-locate-key.xml

<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="function.rnp-locate-key" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>rnp_locate_key</refname>
  <refpurpose>Search for the key</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>rnp_locate_key</methodname>
   <methodparam><type>RnpFFI</type><parameter>ffi</parameter></methodparam>
   <methodparam><type>string</type><parameter>identifier_type</parameter></methodparam>
   <methodparam><type>string</type><parameter>identifier</parameter></methodparam>
  </methodsynopsis>
  <para>
   Note: only valid userids are checked while searching by userid.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>ffi</parameter></term>
    <listitem>
     <para>
      &rnp.parameter.ffi-description;
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>identifier_type</parameter></term>
    <listitem>
     <para>
      Identifier type string: "userid", "keyid", "fingerprint", "grip".
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>identifier</parameter></term>
    <listitem>
     <para>
      PGP User ID (name and email) for "userid" type, hexadecimal string
      that represents key id, fingerprint or key grip correspondingly.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns hexadecimal fingerprint of the key found on success&return.falseforfailure;.
  </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:"~/.phpdoc/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
-->