Source of: /manual/en/function.msg-set-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-set-queue.php',
1 => 'msg_set_queue',
),
'up' =>
array (
0 => 'ref.sem.php',
1 => 'Semaphore Functions',
),
'prev' =>
array (
0 => 'function.msg-send.php',
1 => 'msg_send',
),
'next' =>
array (
0 => 'function.msg-stat-queue.php',
1 => 'msg_stat_queue',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.msg-set-queue" class="refentry">
<div class="refnamediv">
<h1 class="refname">msg_set_queue</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">msg_set_queue</span> — <span class="dc-title">Set information in the message queue data structure</span></p>
</div>
<a name="function.msg-set-queue.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>msg_set_queue</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$queue</tt></span>
, <span class="methodparam"><span class="type">array</span> <tt class="parameter">$data</tt></span>
)</div>
<p class="para rdfs-comment">
<b>msg_set_queue()</b> allows you to change the values of the
msg_perm.uid, msg_perm.gid, msg_perm.mode and msg_qbytes fields of the
underlying message queue data structure.
</p>
<p class="para">
Changing the data structure will require that PHP be running as the same
user that created the queue, owns the queue (as determined by the
existing msg_perm.xxx fields), or be running with root privileges.
root privileges are required to raise the msg_qbytes values above the
system defined limit.
</p>
</div>
<a name="function.msg-set-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">queue</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Message queue resource handle
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">data</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
You specify the values you require by setting the value of the keys
that you require in the <i><tt class="parameter">data</tt></i>
array.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.msg-set-queue.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.msg-set-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-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-get-queue.php" class="function" rel="rdfs-seeAlso">msg_get_queue()</a> - Create or attach to a message queue</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
