php-doc-en/reference/openssl/functions/openssl-csr-export-to-file.xml

93 lines
2.4 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-csr-export-to-file">
<refnamediv>
<refname>openssl_csr_export_to_file</refname>
<refpurpose>Exports a CSR to a file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>openssl_csr_export_to_file</methodname>
<methodparam><type>resource</type><parameter>csr</parameter></methodparam>
<methodparam><type>string</type><parameter>outfilename</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>notext</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
<para>
<function>openssl_csr_export_to_file</function> takes the Certificate
Signing Request represented by <parameter>csr</parameter> and saves it
as ascii-armoured text into the file named by <parameter>outfilename</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>csr</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>notext</parameter></term>
<listitem>
&note.openssl.param-notext;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openssl_csr_export</function></member>
<member><function>openssl_csr_new</function></member>
<member><function>openssl_csr_sign</function></member>
</simplelist>
</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
-->