php-doc-en/reference/openssl/functions/openssl-pkey-export-to-file.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

97 lines
2.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkey-export-to-file">
<refnamediv>
<refname>openssl_pkey_export_to_file</refname>
<refpurpose>Gets an exportable representation of a key into a file </refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openssl_pkey_export_to_file</methodname>
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>outfilename</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>configargs</parameter></methodparam>
</methodsynopsis>
<para>
<function>openssl_pkey_export_to_file</function> saves an ascii-armoured
(PEM encoded) rendition of <parameter>key</parameter> into the file named
by <parameter>outfilename</parameter>.
</para>
&note.openssl.cnf;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>outfilename</parameter></term>
<listitem>
<para>
Path to the output file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>passphrase</parameter></term>
<listitem>
<para>
The key can be optionally protected by a
<parameter>passphrase</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>configargs</parameter></term>
<listitem>
<para>
<parameter>configargs</parameter> can be used to fine-tune the export
process by specifying and/or overriding options for the openssl
configuration file. See <function>openssl_csr_new</function> for more
information about <parameter>configargs</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->