reference/openssl/functions/openssl-free-key.xml
d1e3ea622e5d4f542cd36eca59a9f22aa0142633
...
...
@@ -1,20 +1,24 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-free-key">
3
+
<refentry xml:id="function.openssl-free-key" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>openssl_free_key</refname>
6
6
<refpurpose>Free key resource</refpurpose>
7
7
</refnamediv>
8
8

9
+
<refsynopsisdiv>
10
+
&warn.deprecated.function-8-0-0;
11
+
</refsynopsisdiv>
12
+
9
13
<refsect1 role="description">
10
14
&reftitle.description;
11
15
<methodsynopsis>
12
16
<type>void</type><methodname>openssl_free_key</methodname>
13
-
<methodparam><type>resource</type><parameter>key_identifier</parameter></methodparam>
17
+
<methodparam><type>OpenSSLAsymmetricKey</type><parameter>key</parameter></methodparam>
14
18
</methodsynopsis>
15
19
<para>
16
20
<function>openssl_free_key</function> frees the key associated with
17
-
the specified <parameter>key_identifier</parameter> from memory.
21
+
the specified <parameter>key</parameter> from memory.
18
22
</para>
19
23
</refsect1>
20
24

...
...
@@ -23,7 +27,7 @@
23
27
<para>
24
28
<variablelist>
25
29
<varlistentry>
26
-
<term><parameter>key_identifier</parameter></term>
30
+
<term><parameter>key</parameter></term>
27
31
<listitem>
28
32
<para>
29
33
</para>
...
...
@@ -40,8 +44,36 @@
40
44
</para>
41
45
</refsect1>
42
46

43
-
</refentry>
47
+
<refsect1 role="changelog">
48
+
&reftitle.changelog;
49
+
<informaltable>
50
+
<tgroup cols="2">
51
+
<thead>
52
+
<row>
53
+
<entry>&Version;</entry>
54
+
<entry>&Description;</entry>
55
+
</row>
56
+
</thead>
57
+
<tbody>
58
+
<row>
59
+
<entry>8.0.0</entry>
60
+
<entry>
61
+
This function is now deprecated as it doesn't have an effect anymore.
62
+
</entry>
63
+
</row>
64
+
<row>
65
+
<entry>8.0.0</entry>
66
+
<entry>
67
+
<parameter>key</parameter> accepts an <classname>OpenSSLAsymmetricKey</classname> now;
68
+
previously, a &resource; of type <literal>OpenSSL key</literal> was accepted.
69
+
</entry>
70
+
</row>
71
+
</tbody>
72
+
</tgroup>
73
+
</informaltable>
74
+
</refsect1>
44
75

76
+
</refentry>
45
77
<!-- Keep this comment at the end of the file
46
78
Local variables:
47
79
mode: sgml
48
80