reference/sem/functions/shm-put-var.xml
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-put-var">
3
+
<refentry xml:id="function.shm-put-var" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>shm_put_var</refname>
6
6
<refpurpose>Inserts or updates a variable in shared memory</refpurpose>
...
...
@@ -10,18 +10,18 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>bool</type><methodname>shm_put_var</methodname>
13
-
<methodparam><type>resource</type><parameter>shm_identifier</parameter></methodparam>
14
-
<methodparam><type>int</type><parameter>variable_key</parameter></methodparam>
15
-
<methodparam><type>mixed</type><parameter>variable</parameter></methodparam>
13
+
<methodparam><type>SysvSharedMemory</type><parameter>shm</parameter></methodparam>
14
+
<methodparam><type>int</type><parameter>key</parameter></methodparam>
15
+
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
18
<function>shm_put_var</function> inserts or updates the
19
-
<parameter>variable</parameter> with the given
20
-
<parameter>variable_key</parameter>.
19
+
<parameter>value</parameter> with the given
20
+
<parameter>key</parameter>.
21
21
</para>
22
22
<para>
23
23
Warnings (<constant>E_WARNING</constant> level) will be issued if
24
-
<parameter>shm_identifier</parameter> is not a valid SysV shared memory
24
+
<parameter>shm</parameter> is not a valid SysV shared memory
25
25
index or if there was not enough shared memory remaining to complete your
26
26
request.
27
27
</para>
...
...
@@ -32,16 +32,15 @@
32
32
<para>
33
33
<variablelist>
34
34
<varlistentry>
35
-
<term><parameter>shm_identifier</parameter></term>
35
+
<term><parameter>shm</parameter></term>
36
36
<listitem>
37
37
<para>
38
-
A shared memory resource handle as returned by
39
-
<function>shm_attach</function>
38
+
A shared memory segment obtained from <function>shm_attach</function>.
40
39
</para>
41
40
</listitem>
42
41
</varlistentry>
43
42
<varlistentry>
44
-
<term><parameter>variable_key</parameter></term>
43
+
<term><parameter>key</parameter></term>
45
44
<listitem>
46
45
<para>
47
46
The variable key.
...
...
@@ -49,7 +48,7 @@
49
48
</listitem>
50
49
</varlistentry>
51
50
<varlistentry>
52
-
<term><parameter>variable</parameter></term>
51
+
<term><parameter>value</parameter></term>
53
52
<listitem>
54
53
<para>
55
54
The variable. All <link linkend="language.types">variable types</link>
...
...
@@ -70,6 +69,31 @@
70
69
</para>
71
70
</refsect1>
72
71

72
+
<refsect1 role="changelog">
73
+
&reftitle.changelog;
74
+
<para>
75
+
<informaltable>
76
+
<tgroup cols="2">
77
+
<thead>
78
+
<row>
79
+
<entry>&Version;</entry>
80
+
<entry>&Description;</entry>
81
+
</row>
82
+
</thead>
83
+
<tbody>
84
+
<row>
85
+
<entry>8.0.0</entry>
86
+
<entry>
87
+
<parameter>shm</parameter> expects a <classname>SysvSharedMemory</classname>
88
+
instance now; previously, a <type>resource</type> was expected.
89
+
</entry>
90
+
</row>
91
+
</tbody>
92
+
</tgroup>
93
+
</informaltable>
94
+
</para>
95
+
</refsect1>
96
+
73
97
<refsect1 role="seealso">
74
98
&reftitle.seealso;
75
99
<para>
...
...
@@ -81,7 +105,6 @@
81
105
</refsect1>
82
106

83
107
</refentry>
84
-

85
108
<!-- Keep this comment at the end of the file
86
109
Local variables:
87
110
mode: sgml
88
111