<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Inserts or updates a variable in shared memory</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.shm-has-var.html">shm_has_var</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.shm-remove-var.html">shm_remove_var</a></div>
<div class="up"><a href="ref.sem.html">Semaphore Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><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>
<div class="refsect1 description" id="refsect1-function.shm-put-var-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>shm_put_var</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$shm_identifier</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$variable_key</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$variable</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>shm_put_var()</strong></span> inserts or updates the
<em><code class="parameter">variable</code></em> with the given
<em><code class="parameter">variable_key</code></em>.
</p>
<p class="para">
Warnings (<strong><code>E_WARNING</code></strong> level) will be issued if
<em><code class="parameter">shm_identifier</code></em> is not a valid SysV shared memory
index or if there was not enough shared memory remaining to complete your
request.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.shm-put-var-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">shm_identifier</code></em></span>
<dd>
<p class="para">
A shared memory resource handle as returned by
<span class="function"><a href="function.shm-attach.html" class="function">shm_attach()</a></span>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">variable_key</code></em></span>
<dd>
<p class="para">
The variable key.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">variable</code></em></span>
<dd>
<p class="para">
The variable. All <a href="language.types.html" class="link">variable types</a>
that <span class="function"><a href="function.serialize.html" class="function">serialize()</a></span> supports may be used: generally
this means all types except for resources and some internal objects
that cannot be serialized.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.shm-put-var-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.shm-put-var-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.shm-get-var.html" class="function" rel="rdfs-seeAlso">shm_get_var()</a> - Returns a variable from shared memory</span></li>
<li class="member"> <span class="function"><a href="function.shm-has-var.html" class="function" rel="rdfs-seeAlso">shm_has_var()</a> - Check whether a specific entry exists</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.shm-has-var.html">shm_has_var</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.shm-remove-var.html">shm_remove_var</a></div>
<div class="up"><a href="ref.sem.html">Semaphore Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
