reference/sem/functions/msg-get-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-get-queue">
3
+
<refentry xml:id="function.msg-get-queue" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>msg_get_queue</refname>
6
6
<refpurpose>Create or attach to a message queue</refpurpose>
...
...
@@ -9,15 +9,15 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>resource</type><methodname>msg_get_queue</methodname>
12
+
<type class="union"><type>SysvMessageQueue</type><type>false</type></type><methodname>msg_get_queue</methodname>
13
13
<methodparam><type>int</type><parameter>key</parameter></methodparam>
14
-
<methodparam choice="opt"><type>int</type><parameter>perms</parameter><initializer>0666</initializer></methodparam>
14
+
<methodparam choice="opt"><type>int</type><parameter>permissions</parameter><initializer>0666</initializer></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
17
<function>msg_get_queue</function> returns an id that can be used to
18
18
access the System V message queue with the given
19
19
<parameter>key</parameter>. The first call creates the message queue with
20
-
the optional <parameter>perms</parameter>.
20
+
the optional <parameter>permissions</parameter>.
21
21
A second call to <function>msg_get_queue</function> for the same
22
22
<parameter>key</parameter> will return a different message queue
23
23
identifier, but both identifiers access the same underlying message
...
...
@@ -38,11 +38,11 @@
38
38
</listitem>
39
39
</varlistentry>
40
40
<varlistentry>
41
-
<term><parameter>perms</parameter></term>
41
+
<term><parameter>permissions</parameter></term>
42
42
<listitem>
43
43
<para>
44
44
Queue permissions. Default to 0666. If the message queue already
45
-
exists, the <parameter>perms</parameter> will be ignored.
45
+
exists, the <parameter>permissions</parameter> will be ignored.
46
46
</para>
47
47
</listitem>
48
48
</varlistentry>
...
...
@@ -53,7 +53,33 @@
53
53
<refsect1 role="returnvalues">
54
54
&reftitle.returnvalues;
55
55
<para>
56
-
Returns a resource handle that can be used to access the System V message queue.
56
+
Returns <classname>SysvMessageQueue</classname> instance that can be used to access the System V message queue,
57
+
&return.falseforfailure;.
58
+
</para>
59
+
</refsect1>
60
+
61
+
<refsect1 role="changelog">
62
+
&reftitle.changelog;
63
+
<para>
64
+
<informaltable>
65
+
<tgroup cols="2">
66
+
<thead>
67
+
<row>
68
+
<entry>&Version;</entry>
69
+
<entry>&Description;</entry>
70
+
</row>
71
+
</thead>
72
+
<tbody>
73
+
<row>
74
+
<entry>8.0.0</entry>
75
+
<entry>
76
+
On success, this function returns a <classname>SysvMessageQueue</classname> instance now;
77
+
previously, a <type>resource</type> was returned.
78
+
</entry>
79
+
</row>
80
+
</tbody>
81
+
</tgroup>
82
+
</informaltable>
57
83
</para>
58
84
</refsect1>
59
85
...
...
@@ -71,7 +97,6 @@
71
97
</refsect1>
72
98
73
99
</refentry>
74
-
75
100
<!-- Keep this comment at the end of the file
76
101
Local variables:
77
102
mode: sgml
78
103