Source of: /manual/en/function.shm-put-var.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.shm-put-var.php',
1 => 'shm_put_var',
),
'up' =>
array (
0 => 'ref.sem.php',
1 => 'Semaphore Functions',
),
'prev' =>
array (
0 => 'function.shm-has-var.php',
1 => 'shm_has_var',
),
'next' =>
array (
0 => 'function.shm-remove-var.php',
1 => 'shm_remove_var',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.shm-put-var" class="refentry">
<div class="refnamediv">
<h1 class="refname">shm_put_var</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">shm_put_var</span> — <span class="dc-title">Inserts or updates a variable in shared memory</span></p>
</div>
<a name="function.shm-put-var.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>shm_put_var</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$shm_identifier</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$variable_key</tt></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter">$variable</tt></span>
)</div>
<p class="para rdfs-comment">
<b>shm_put_var()</b> inserts or updates the
<i><tt class="parameter">variable</tt></i>
with the given
<i><tt class="parameter">variable_key</tt></i>
.
</p>
<p class="para">
Warnings (<b><tt class="constant">E_WARNING</tt></b> level) will be issued if
<i><tt class="parameter">shm_identifier</tt></i>
is not a valid SysV shared memory
index or if there was not enough shared memory remaining to complete your
request.
</p>
</div>
<a name="function.shm-put-var.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">shm_identifier</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
A shared memory resource handle as returned by
<a href="function.shm-attach.php" class="function">shm_attach()</a>
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">variable_key</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The variable key.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">variable</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The variable. All <a href="language.types.php" class="link"> variable-types</a>
are supported.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.shm-put-var.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.shm-put-var.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.shm-get-var.php" class="function" rel="rdfs-seeAlso">shm_get_var()</a> - Returns a variable from shared memory</li>
<li class="member"><a href="function.shm-has-var.php" class="function" rel="rdfs-seeAlso">shm_has_var()</a> - Check whether a specific entry exists</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
