reference/shmop/functions/shmop-read.xml
f1446c725b05024034664159db4d5f34b56421d0
f1446c725b05024034664159db4d5f34b56421d0
...
...
@@ -9,9 +9,9 @@
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
11
<type>string</type><methodname>shmop_read</methodname>
12
-
<methodparam><type>resource</type><parameter>shmid</parameter></methodparam>
13
-
<methodparam><type>int</type><parameter>start</parameter></methodparam>
14
-
<methodparam><type>int</type><parameter>count</parameter></methodparam>
12
+
<methodparam><type>Shmop</type><parameter>shmop</parameter></methodparam>
13
+
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
14
+
<methodparam><type>int</type><parameter>size</parameter></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
17
<function>shmop_read</function> will read a string from shared memory block.
...
...
@@ -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
...
...
@@ -31,18 +31,21 @@
31
31
</listitem>
32
32
</varlistentry>
33
33
<varlistentry>
34
-
<term><parameter>start</parameter></term>
34
+
<term><parameter>offset</parameter></term>
35
35
<listitem>
36
36
<para>
37
-
Offset from which to start reading
37
+
Offset from which to start reading; must be greater than or equal to zero
38
+
and less than or equal to the actual size of the shared memory segment.
38
39
</para>
39
40
</listitem>
40
41
</varlistentry>
41
42
<varlistentry>
42
-
<term><parameter>count</parameter></term>
43
+
<term><parameter>size</parameter></term>
43
44
<listitem>
44
45
<para>
45
-
The number of bytes to read.
46
+
The number of bytes to read; must be greater than or equal to zero,
47
+
and the sum of <parameter>offset</parameter> and <parameter>size </parameter>
48
+
must be less than or equal to the actual size of the shared memory segment.
46
49
<literal>0</literal> reads <code>shmop_size($shmid) - $start</code> bytes.
47
50
</para>
48
51
</listitem>
...
...
@@ -57,6 +60,14 @@
57
60
</para>
58
61
</refsect1>
59
62
63
+
<refsect1 role="errors">
64
+
&reftitle.errors;
65
+
<para>
66
+
If <parameter>offset</parameter> or <parameter>size</parameter> are out of range,
67
+
a <classname>ValueError</classname> is thrown.
68
+
</para>
69
+
</refsect1>
70
+
60
71
<refsect1 role="changelog">
61
72
&reftitle.changelog;
62
73
<informaltable>
...
...
@@ -69,10 +80,18 @@
69
80
</thead>
70
81
<tbody>
71
82
<row>
72
-
<entry>7.0.0</entry>
83
+
<entry>8.0.0</entry>
73
84
<entry>
74
-
The type of <parameter>shmid</parameter> has been changed from
75
-
<type>int</type> to <type>resource</type>.
85
+
<parameter>shmop</parameter> expects a <classname>Shmop</classname>
86
+
instance now; previously, a <type>resource</type> was expected.
87
+
</entry>
88
+
</row>
89
+
<row>
90
+
<entry>8.0.0</entry>
91
+
<entry>
92
+
If <parameter>offset</parameter> or <parameter>size</parameter> are out of range,
93
+
a <classname>ValueError</classname> is thrown; previously <constant>E_WARNING</constant>
94
+
was emitted, and &false; was returned,
76
95
</entry>
77
96
</row>
78
97
</tbody>
...
...
@@ -108,7 +127,6 @@ $shm_data = shmop_read($shm_id, 0, 50);
108
127
</para>
109
128
</refsect1>
110
129
</refentry>
111
-
112
130
<!-- Keep this comment at the end of the file
113
131
Local variables:
114
132
mode: sgml
115
133