reference/shmop/functions/shmop-write.xml
f1446c725b05024034664159db4d5f34b56421d0
f1446c725b05024034664159db4d5f34b56421d0
...
...
@@ -9,7 +9,7 @@
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
11
<type>int</type><methodname>shmop_write</methodname>
12
-
<methodparam><type>resource</type><parameter>shmid</parameter></methodparam>
12
+
<methodparam><type>Shmop</type><parameter>shmop</parameter></methodparam>
13
13
<methodparam><type>string</type><parameter>data</parameter></methodparam>
14
14
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
15
15
</methodsynopsis>
...
...
@@ -22,7 +22,7 @@
22
22
<para>
23
23
<variablelist>
24
24
<varlistentry>
25
-
<term><parameter>shmid</parameter></term>
25
+
<term><parameter>shmop</parameter></term>
26
26
<listitem>
27
27
<para>
28
28
The shared memory block identifier created by
...
...
@@ -43,7 +43,8 @@
43
43
<listitem>
44
44
<para>
45
45
Specifies where to start writing data inside the shared memory
46
-
segment.
46
+
segment. The offset must be greater than or equal to zero
47
+
and less than or equal to the actual size of the shared memory segment.
47
48
</para>
48
49
</listitem>
49
50
</varlistentry>
...
...
@@ -53,8 +54,15 @@
53
54
<refsect1 role="returnvalues">
54
55
&reftitle.returnvalues;
55
56
<para>
56
-
The size of the written <parameter>data</parameter>, or &false; on
57
-
failure.
57
+
The size of the written <parameter>data</parameter>.
58
+
</para>
59
+
</refsect1>
60
+
61
+
<refsect1 role="errors">
62
+
&reftitle.errors;
63
+
<para>
64
+
If <parameter>offset</parameter> is out of range, or a read-only shared memory segment
65
+
should be written to, a <classname>ValueError</classname> is thrown.
58
66
</para>
59
67
</refsect1>
60
68
...
...
@@ -70,10 +78,16 @@
70
78
</thead>
71
79
<tbody>
72
80
<row>
73
-
<entry>7.0.0</entry>
81
+
<entry>8.0.0</entry>
74
82
<entry>
75
-
The type of <parameter>shmid</parameter> has been changed from
76
-
<type>int</type> to <type>resource</type>.
83
+
Prior to PHP 8.0.0, &false; was returned on failure.
84
+
</entry>
85
+
</row>
86
+
<row>
87
+
<entry>8.0.0</entry>
88
+
<entry>
89
+
<parameter>shmop</parameter> expects a <classname>Shmop</classname>
90
+
instance now; previously, a <type>resource</type> was expected.
77
91
</entry>
78
92
</row>
79
93
</tbody>
...
...
@@ -110,7 +124,6 @@ $shm_bytes_written = shmop_write($shm_id, $my_string, 0);
110
124
</para>
111
125
</refsect1>
112
126
</refentry>
113
-
114
127
<!-- Keep this comment at the end of the file
115
128
Local variables:
116
129
mode: sgml
117
130