sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document openssl_pkey_get_details()

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@242699 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jakub Vrana 2007-09-19 12:11:52 +00:00
parent ea317e934d
commit 3daeedc139
2 changed files with 37 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
reference/openssl/functions/openssl-pkey-free.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkey-free">
<refnamediv>
<refname>openssl_pkey_free</refname>
@ -26,6 +26,7 @@
<term><parameter>key</parameter></term>
<listitem>
<para>
Resource holding the key.
</para>
</listitem>
</varlistentry>

38
reference/openssl/functions/openssl-pkey-get-details.xml
View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkey-get-details">
<refnamediv>
<refname>openssl_pkey_get_details</refname>
<refpurpose>Returns an array with the key details (bits, pkey, type)</refpurpose>
<refpurpose>Returns an array with the key details</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -12,7 +12,39 @@
<type>array</type><methodname>openssl_pkey_get_details</methodname>
<methodparam><type>resource</type><parameter>key</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
This function returns the key details (bits, key, type).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
Resource holding the key.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array with the key details in success or &false; in failure.
Returned array has indexes <literal>bits</literal> (number of bits),
<literal>key</literal> (string representation of the public key) and
<literal>type</literal> (type of the key which is one of
<constant>OPENSSL_KEYTYPE_RSA</constant>,
<constant>OPENSSL_KEYTYPE_DSA</constant>,
<constant>OPENSSL_KEYTYPE_DH</constant>,
<constant>OPENSSL_KEYTYPE_EC</constant> or -1 meaning unknown).
</para>
</refsect1>
</refentry>