reference/sem/functions/msg-stat-queue.xml
f7e33278a909d7f7bf491f77cb10c93581091736
f7e33278a909d7f7bf491f77cb10c93581091736
...
...
@@ -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.msg-stat-queue">
3
+
<refentry xml:id="function.msg-stat-queue" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>msg_stat_queue</refname>
6
6
<refpurpose>Returns information from the message queue data structure</refpurpose>
...
...
@@ -9,8 +9,8 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>array</type><methodname>msg_stat_queue</methodname>
13
-
<methodparam><type>resource</type><parameter>queue</parameter></methodparam>
12
+
<type class="union"><type>array</type><type>false</type></type><methodname>msg_stat_queue</methodname>
13
+
<methodparam><type>SysvMessageQueue</type><parameter>queue</parameter></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
16
<function>msg_stat_queue</function> returns the message queue meta data
...
...
@@ -28,7 +28,7 @@
28
28
<term><parameter>queue</parameter></term>
29
29
<listitem>
30
30
<para>
31
-
Message queue resource handle
31
+
The message queue.
32
32
</para>
33
33
</listitem>
34
34
</varlistentry>
...
...
@@ -39,7 +39,7 @@
39
39
<refsect1 role="returnvalues">
40
40
&reftitle.returnvalues;
41
41
<para>
42
-
The return value is an array whose keys and values have the following
42
+
On success, the return value is an array whose keys and values have the following
43
43
meanings:
44
44
<table>
45
45
<title>Array structure for msg_stat_queue</title>
...
...
@@ -111,6 +111,34 @@
111
111
</tgroup>
112
112
</table>
113
113
</para>
114
+
<para>
115
+
Returns &false; on failure.
116
+
</para>
117
+
</refsect1>
118
+
119
+
<refsect1 role="changelog">
120
+
&reftitle.changelog;
121
+
<para>
122
+
<informaltable>
123
+
<tgroup cols="2">
124
+
<thead>
125
+
<row>
126
+
<entry>&Version;</entry>
127
+
<entry>&Description;</entry>
128
+
</row>
129
+
</thead>
130
+
<tbody>
131
+
<row>
132
+
<entry>8.0.0</entry>
133
+
<entry>
134
+
<parameter>queue</parameter> expects a <classname>SysvMessageQueue</classname>
135
+
instance now; previously, a <type>resource</type> was expected.
136
+
</entry>
137
+
</row>
138
+
</tbody>
139
+
</tgroup>
140
+
</informaltable>
141
+
</para>
114
142
</refsect1>
115
143
116
144
<refsect1 role="seealso">
...
...
@@ -126,7 +154,6 @@
126
154
</refsect1>
127
155
128
156
</refentry>
129
-
130
157
<!-- Keep this comment at the end of the file
131
158
Local variables:
132
159
mode: sgml
133
160