Source of: /manual/en/function.msg-get-queue.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sem.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.msg-get-queue.php',
1 => 'msg_get_queue',
),
'up' =>
array (
0 => 'ref.sem.php',
1 => 'Semaphore Functions',
),
'prev' =>
array (
0 => 'function.ftok.php',
1 => 'ftok',
),
'next' =>
array (
0 => 'function.msg-queue-exists.php',
1 => 'msg_queue_exists',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.msg-get-queue" class="refentry">
<div class="refnamediv">
<h1 class="refname">msg_get_queue</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">msg_get_queue</span> — <span class="dc-title">Create or attach to a message queue</span></p>
</div>
<a name="function.msg-get-queue.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><b>msg_get_queue</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$key</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$perms</tt></span>
] )</div>
<p class="para rdfs-comment">
<b>msg_get_queue()</b> returns an id that can be used to
access the System V message queue with the given
<i><tt class="parameter">key</tt></i>
. The first call creates the message queue with
the optional <i><tt class="parameter">perms</tt></i>
.
A second call to <b>msg_get_queue()</b> for the same
<i><tt class="parameter">key</tt></i>
will return a different message queue
identifier, but both identifiers access the same underlying message
queue.
</p>
</div>
<a name="function.msg-get-queue.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">key</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Message queue numeric ID
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">perms</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Queue permissions. Default to 0666. If the message queue already
exists, the <i><tt class="parameter">perms</tt></i>
will be ignored.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.msg-get-queue.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a resource handle that can be used to access the System V message queue.
</p>
</div>
<a name="function.msg-get-queue.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.msg-remove-queue.php" class="function" rel="rdfs-seeAlso">msg_remove_queue()</a> - Destroy a message queue</li>
<li class="member"><a href="function.msg-receive.php" class="function" rel="rdfs-seeAlso">msg_receive()</a> - Receive a message from a message queue</li>
<li class="member"><a href="function.msg-send.php" class="function" rel="rdfs-seeAlso">msg_send()</a> - Send a message to a message queue</li>
<li class="member"><a href="function.msg-stat-queue.php" class="function" rel="rdfs-seeAlso">msg_stat_queue()</a> - Returns information from the message queue data structure</li>
<li class="member"><a href="function.msg-set-queue.php" class="function" rel="rdfs-seeAlso">msg_set_queue()</a> - Set information in the message queue data structure</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
