reference/sem/functions/shm-remove-var.xml
395ea247cf337110d795979e14841617aa9cefa9
395ea247cf337110d795979e14841617aa9cefa9
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shm-remove-var">
3
+
<refentry xml:id="function.shm-remove-var" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>shm_remove_var</refname>
6
6
<refpurpose>Removes a variable from shared memory
...
...
@@ -11,11 +11,11 @@
11
11
&reftitle.description;
12
12
<methodsynopsis>
13
13
<type>bool</type><methodname>shm_remove_var</methodname>
14
-
<methodparam><type>resource</type><parameter>shm_identifier</parameter></methodparam>
15
-
<methodparam><type>int</type><parameter>variable_key</parameter></methodparam>
14
+
<methodparam><type>SysvSharedMemory</type><parameter>shm</parameter></methodparam>
15
+
<methodparam><type>int</type><parameter>key</parameter></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
-
Removes a variable with a given <parameter>variable_key</parameter>
18
+
Removes a variable with a given <parameter>key</parameter>
19
19
and frees the occupied memory.
20
20
</para>
21
21
</refsect1>
...
...
@@ -25,16 +25,15 @@
25
25
<para>
26
26
<variablelist>
27
27
<varlistentry>
28
-
<term><parameter>shm_identifier</parameter></term>
28
+
<term><parameter>shm</parameter></term>
29
29
<listitem>
30
30
<para>
31
-
The shared memory identifier as returned by
32
-
<function>shm_attach</function>
31
+
A shared memory segment obtained from <function>shm_attach</function>.
33
32
</para>
34
33
</listitem>
35
34
</varlistentry>
36
35
<varlistentry>
37
-
<term><parameter>variable_key</parameter></term>
36
+
<term><parameter>key</parameter></term>
38
37
<listitem>
39
38
<para>
40
39
The variable key.
...
...
@@ -52,6 +51,31 @@
52
51
</para>
53
52
</refsect1>
54
53
54
+
<refsect1 role="changelog">
55
+
&reftitle.changelog;
56
+
<para>
57
+
<informaltable>
58
+
<tgroup cols="2">
59
+
<thead>
60
+
<row>
61
+
<entry>&Version;</entry>
62
+
<entry>&Description;</entry>
63
+
</row>
64
+
</thead>
65
+
<tbody>
66
+
<row>
67
+
<entry>8.0.0</entry>
68
+
<entry>
69
+
<parameter>shm</parameter> expects a <classname>SysvSharedMemory</classname>
70
+
instance now; previously, a <type>resource</type> was expected.
71
+
</entry>
72
+
</row>
73
+
</tbody>
74
+
</tgroup>
75
+
</informaltable>
76
+
</para>
77
+
</refsect1>
78
+
55
79
<refsect1 role="seealso">
56
80
&reftitle.seealso;
57
81
<para>
...
...
@@ -62,7 +86,6 @@
62
86
</refsect1>
63
87
64
88
</refentry>
65
-
66
89
<!-- Keep this comment at the end of the file
67
90
Local variables:
68
91
mode: sgml
69
92